René's URL Explorer Experiment


Title: [DX] GAP-14: uipath.json functions format is undocumented — the error message is the only spec · Issue #1504 · UiPath/uipath-python · GitHub

Open Graph Title: [DX] GAP-14: uipath.json functions format is undocumented — the error message is the only spec · Issue #1504 · UiPath/uipath-python

X Title: [DX] GAP-14: uipath.json functions format is undocumented — the error message is the only spec · Issue #1504 · UiPath/uipath-python

Description: Summary The expected format for function entries in uipath.json is a plain string "module.py:function_name". This is not documented anywhere — the only specification is the error message produced when the wrong format is used. Root Cause...

Open Graph Description: Summary The expected format for function entries in uipath.json is a plain string "module.py:function_name". This is not documented anywhere — the only specification is the error message produced w...

X Description: Summary The expected format for function entries in uipath.json is a plain string "module.py:function_name". This is not documented anywhere — the only specification is the error message ...

Opengraph URL: https://github.com/UiPath/uipath-python/issues/1504

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[DX] GAP-14: uipath.json functions format is undocumented — the error message is the only spec","articleBody":"## Summary\n\nThe expected format for function entries in `uipath.json` is a plain string `\"module.py:function_name\"`. This is not documented anywhere — the only specification is the error message produced when the wrong format is used.\n\n## Root Cause\n\nAfter seeing the `uipath.json` `entryPoints` format (which uses objects with `filePath`, `type`, etc.), a developer would reasonably attempt:\n\n```json\n{\n  \"functions\": {\n    \"check_vendor_risk\": {\n      \"filePath\": \"invoice_tools/vendor.py\",\n      \"description\": \"Checks vendor risk level\"\n    }\n  }\n}\n```\n\n`uipath init` rejects this with:\n```\nInvalid function specification: '{\"filePath\": \"...\"}' — expected 'path/to/file.py:function_name'\n```\n\nThe error message is the only documentation for the expected format. It is not mentioned in:\n- CLI `--help` output\n- The `$schema` file\n- The getting-started guide\n- Any samples\n\n## Workaround\n\nUse the string format:\n```json\n{\n  \"functions\": {\n    \"check_vendor_risk\": \"invoice_tools/vendor.py:check_vendor_risk\"\n  }\n}\n```\n\n## Suggested Fix\n\n1. Document the expected format in the `$schema` for `uipath.json`\n2. Add it to the CLI `--help` output for `uipath init`\n3. Add it to the getting-started guide and function samples\n4. Consider accepting an object format for richer metadata:\n   ```json\n   {\n     \"check_vendor_risk\": {\n       \"filePath\": \"invoice_tools/vendor.py\",\n       \"functionName\": \"check_vendor_risk\",\n       \"description\": \"Checks vendor risk level in Salesforce\"\n     }\n   }\n   ```\n   The CLI already generates descriptions in `entry-points.json` from docstrings — this would allow developers to provide them explicitly.\n\n## Impact\n\n- Severity: **Medium** (documentation gap causing confusing errors)\n- The error message is the only specification, which is a poor developer experience\n- The object format is a reasonable assumption given the rest of `uipath.json` uses objects\n","author":{"url":"https://github.com/AlexBizon","@type":"Person","name":"AlexBizon"},"datePublished":"2026-03-26T15:26:19Z","url":"https://github.com/UiPath/uipath-python/issues/1504"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:720e192f-66f6-4cbc-bd53-ccf941fd8733
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idDD1C:26CFA5:1D3D12:276D68:6AFF62B2
html-safe-nonce40043c2e0ad82207bb8371fecc7e4862d6abdc1aed9d4d0bce097196e1e8bfd1
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJERDFDOjI2Q0ZBNToxRDNEMTI6Mjc2RDY4OjZBRkY2MkIyIiwidmlzaXRvcl9pZCI6IjIxNTkwOTM3MjgwODAyNTc3MTQiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmacdb2129f779cbe8a3feb29cd3eb8dd5f6e63655c20104001dfc53f67abae1dc9c
hovercard-subject-tagissue:4145005831
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/UiPath/uipath-python/1504/issue_layout
twitter:imagehttps://opengraph.githubassets.com/fd6e8c31cde6d0f9082b8662a00f4d3fefc6604d139643360c744863c7c791de/UiPath/uipath-python/issues/1504
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/fd6e8c31cde6d0f9082b8662a00f4d3fefc6604d139643360c744863c7c791de/UiPath/uipath-python/issues/1504
og:image:altSummary The expected format for function entries in uipath.json is a plain string "module.py:function_name". This is not documented anywhere — the only specification is the error message produced w...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameAlexBizon
hostnamegithub.com
expected-hostnamegithub.com
None41b58589a1c4eda1e3c8904144a412b88ca4455f63ca2ad3629f2e9f3c3a1d12
turbo-cache-controlno-preview
go-importgithub.com/UiPath/uipath-python git https://github.com/UiPath/uipath-python.git
octolytics-dimension-user_id375663
octolytics-dimension-user_loginUiPath
octolytics-dimension-repository_id925171912
octolytics-dimension-repository_nwoUiPath/uipath-python
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id925171912
octolytics-dimension-repository_network_root_nwoUiPath/uipath-python
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release8968d6d6acc65d74e4df332d23932dd3fd0502a4
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/UiPath/uipath-python/issues/1504#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FUiPath%2Fuipath-python%2Fissues%2F1504
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FUiPath%2Fuipath-python%2Fissues%2F1504
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=UiPath%2Fuipath-python
Reloadhttps://github.com/UiPath/uipath-python/issues/1504
Reloadhttps://github.com/UiPath/uipath-python/issues/1504
Reloadhttps://github.com/UiPath/uipath-python/issues/1504
UiPathhttps://github.com/UiPath
uipath-pythonhttps://github.com/UiPath/uipath-python
Codehttps://github.com/UiPath/uipath-python
Issues81 (81)https://github.com/UiPath/uipath-python/issues
Pull requests144 (144)https://github.com/UiPath/uipath-python/pulls
Actionshttps://github.com/UiPath/uipath-python/actions
Projectshttps://github.com/UiPath/uipath-python/projects
Security and qualityhttps://github.com/UiPath/uipath-python/security
Insightshttps://github.com/UiPath/uipath-python/insights
https://github.com/UiPath/uipath-python
New issuehttps://github.com/login?return_to=https://github.com/UiPath/uipath-python/issues/1504
New issuehttps://github.com/login?return_to=https://github.com/UiPath/uipath-python/issues/1504
[DX] GAP-14: uipath.json functions format is undocumented — the error message is the only spechttps://github.com/UiPath/uipath-python/issues/1504#top
https://github.com/AlexBizon
AlexBizonhttps://github.com/AlexBizon
on Mar 26, 2026https://github.com/UiPath/uipath-python/issues/1504#issue-4145005831
Sign up for freehttps://github.com/signup?return_to=https://github.com/UiPath/uipath-python/issues/1504
Sign in to commenthttps://github.com/login?return_to=https://github.com/UiPath/uipath-python/issues/1504
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.