docs(solution,platform): five UV fixes — env-var format, role lookup, connection repoint, deploy folder - #2383
docs(solution,platform): five UV fixes — env-var format, role lookup, connection repoint, deploy folder#2383alexenica wants to merge 6 commits into
Conversation
… lookup uipath-solution: `resources refresh` now reports `Pruned` and removes the connection resource orphaned when a binding is repointed to a different connection GUID. Documents what the prune does and does not touch, and corrects the two places that stated refresh never removes anything. Also notes that an Enabled, pingable connection can still be missing from the Resource Catalog, since RCS indexing is per folder. uipath-platform: documents `roles users list` as the forward "who holds this role" lookup now that it scopes to actual members, so auditing is one call per role instead of a directory sweep per principal. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Claude finished @alexenica's task in 2m 2s —— View job PR Review: docs(solution) — connection-repoint prune and role member lookup
SummaryDocs-only PR documenting two CLI behavior changes: (1) the connection-repoint prune in Change-by-Change Review1.
|
| Area | Status | Notes |
|---|---|---|
| Frontmatter | OK | No frontmatter changes in this PR |
| E2E Tests | OK | Doc-only changes to existing reference files — no new CLI workflows or capabilities that warrant new test tasks (the commands already existed, just weren't fully documented) |
| Skill Body | OK | No SKILL.md changes |
| References & Assets | OK | Both reference files are internally consistent; all anchor links resolve; no cross-skill references |
| Repo Hygiene | OK | No secrets, no personal paths, changes scoped to the two relevant skills |
Issues for Manual Review
- The
roles users listand connection-prune behaviors are documented from alpha testing per the PR description. Verify these match the GA CLI release if the paired CLI branch hasn't merged yet.
Conclusion
Clean PR. Both additions fill documented skill gaps (UV-15516 and UV-15580), are well-scoped, internally consistent, and follow the repo's token-optimized writing style. No issues found — approve.
Documented as a JSON object; Orchestrator actually stores newline-separated KEY=VALUE pairs. Verified against a live tenant: create and update both round-trip 'FOO=bar\nBAZ=qux'. Adds the clear-them example and flags that jobs start still validates JSON while its runtime contract is unconfirmed. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Replaces the earlier description of a prune that is not being implemented. Refresh stays import-only: repointing a binding to a different connection GUID imports the new connection as <name>_1 and leaves the resource for the old GUID in place. Documents that shape and points at `resources remove` for cleanup, which is what UV-15516 asked for as the alternative to changing refresh. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…UE format Was flagged as unconfirmed while the CLI still validated JSON there. The format matches the process-level flag, and jobs start now validates it that way, so the caveat is replaced with the plain contract. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…taken The doc said deployment fails if the folder already exists. It doesn't — Orchestrator collision-renames the new folder (`MySolution` → `MySolution 1`) and deploys there. That is exactly the trap in UV-15346: the reporter ran `deploy run` ~8 times against an existing folder holding assets, an IXP folder-deployment and a robot, got 8 new empty folders instead of an error, and runtime resolution then failed on the missing resources. Also states plainly that deploying into a pre-existing folder is not possible: the install API takes `solutionRootFolderName` — a name, not a folder key — so there is nothing to address the target with. Documents the two workarounds (deploy first then provision into the folder it created; or bind each piece with `or packages upload` + `or processes create`), and points readers at `Data.FolderPath` in the response rather than the name they passed. No CLI change: the gap is in the API contract, not in the wrapper. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
deploy run resolves the folder a deployment actually landed in and emits RequestedFolderName + FolderNote when it differs from --folder-name. Documents that shape so readers know the rename is now detectable rather than silent. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Doc side of the whole batch, consolidated into one PR. Pairs with UiPath/cli#3329.
Claims here were checked against live behaviour on alpha via the paired CLI branch, not written from the diff.
uipath-platform — environment variables format
--environment-variableswas documented as a JSON object. Orchestrator stores newline-separatedKEY=VALUE; the JSON shape was silently discarded. Corrected forprocesses create/update, with the clear-them example, and forjobs start(which was flagged as unconfirmed in an earlier revision — the CLI now validates the same format there).uipath-platform —
roles users listUV-15580 made this usable as the forward "who holds this role" lookup, so it is documented next to
user-roles/user-permissions, including thatPagination.Totalis the real membership count. The old workaround — sweeping every principal — is no longer needed.uipath-solution — repointing a connection
UV-15516 asked for this under "SKILL-DOC GAP". Refresh is not changing: a prune was prototyped and rejected, so the documented behaviour is what actually happens — repointing imports the new connection as
<name>_1and leaves the old resource in place, unreferenced but still listed and still indebug_overwrites.json. Cleanup is a manualuip solution resources remove <old-key>, and the section says why refresh does not do it: it never removes resources, so it cannot silently drop something added on purpose.Also corrects the two places that claimed refresh "never overwrites" without qualification, and documents the ticket's secondary finding — an
Enabled, pingable connection can still be missing from the Resource Catalog because RCS indexing is per folder.uipath-solution —
deploy runand foldersTwo corrections, both from UV-15346:
MySolution→MySolution 1) and deploys there. That wrong sentence is the whole trap: the reporter expected success or an error and got eight new empty folders.PipelinesInstallRequesttakessolutionRootFolderName— a name, not a folder key — so the target cannot be addressed. An API-contract limitation, not a missing flag.Adds the two workarounds (preferred: let deploy create the folder, then provision into what it returns), and documents the
RequestedFolderName+FolderNotesignal the CLI now emits on a rename, so readers know it is detectable rather than silent.🤖 Generated with Claude Code