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
Domain: github.com
{"@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-profiling | 0 |
| react-import-map | react,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-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:720e192f-66f6-4cbc-bd53-ccf941fd8733 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | DD1C:26CFA5:1D3D12:276D68:6AFF62B2 |
| html-safe-nonce | 40043c2e0ad82207bb8371fecc7e4862d6abdc1aed9d4d0bce097196e1e8bfd1 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJERDFDOjI2Q0ZBNToxRDNEMTI6Mjc2RDY4OjZBRkY2MkIyIiwidmlzaXRvcl9pZCI6IjIxNTkwOTM3MjgwODAyNTc3MTQiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | db2129f779cbe8a3feb29cd3eb8dd5f6e63655c20104001dfc53f67abae1dc9c |
| hovercard-subject-tag | issue:4145005831 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/UiPath/uipath-python/1504/issue_layout |
| twitter:image | https://opengraph.githubassets.com/fd6e8c31cde6d0f9082b8662a00f4d3fefc6604d139643360c744863c7c791de/UiPath/uipath-python/issues/1504 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/fd6e8c31cde6d0f9082b8662a00f4d3fefc6604d139643360c744863c7c791de/UiPath/uipath-python/issues/1504 |
| og:image:alt | 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... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | AlexBizon |
| hostname | github.com |
| expected-hostname | github.com |
| None | 41b58589a1c4eda1e3c8904144a412b88ca4455f63ca2ad3629f2e9f3c3a1d12 |
| turbo-cache-control | no-preview |
| go-import | github.com/UiPath/uipath-python git https://github.com/UiPath/uipath-python.git |
| octolytics-dimension-user_id | 375663 |
| octolytics-dimension-user_login | UiPath |
| octolytics-dimension-repository_id | 925171912 |
| octolytics-dimension-repository_nwo | UiPath/uipath-python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 925171912 |
| octolytics-dimension-repository_network_root_nwo | UiPath/uipath-python |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 8968d6d6acc65d74e4df332d23932dd3fd0502a4 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width