Skip to content

fix(hitl): align flow plugin hitl/impl.md with CLI contract#642

Open
dushyant-uipath wants to merge 1 commit intomainfrom
fix/hitl-flow-plugin-node-outputs
Open

fix(hitl): align flow plugin hitl/impl.md with CLI contract#642
dushyant-uipath wants to merge 1 commit intomainfrom
fix/hitl-flow-plugin-node-outputs

Conversation

@dushyant-uipath
Copy link
Copy Markdown
Collaborator

Summary

Alignment fixes in skills/uipath-maestro-flow/references/author/references/plugins/hitl/impl.md:

  • Remove spurious action: "Continue"/"End" from QuickForm outcomes example (was removed from hitl-node-quickform.md in fix(hitl): remove spurious action field from outcomes, add globals variable discovery #627 but missed here)
  • Strip description fields from node instance outputs (not generated by CLI; lives in definition's outputDefinition, not the instance)
  • Add per-field custom: true entry to the Quick Reference outputs JSON and document $vars.<variable> as a workflow-global variable path
  • Fix $vars.{nodeId}.status description from "action value" to "outcome id" (returns e.g. "approve", not "Continue")

Background

Corresponds to uipcli PR #1894 (HITL node.outputs fix). The Quick Reference node JSON was showing stale fields that the CLI does not write, causing divergence between what the skill documents and what the actual .flow file contains.

Test plan

  • QuickForm outcomes in impl.md no longer have action field
  • outputs block matches CLI output format
  • status variable description correctly says "outcome id"

- Remove spurious action: "Continue"/"End" from QuickForm outcomes example
  (not written by addHitlNode; already removed from hitl-node-quickform.md
  in #627 but missed here)
- Strip description fields from node instance outputs (not generated by CLI)
- Add per-field outputs entry with custom: true to the Quick Reference JSON
  and document $vars.<variable> as a workflow-global variable
- Fix status description from "action value" to "outcome id"
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

Claude finished @dushyant-uipath's task in 2m 5s —— View job


Review: PR #642

  • Read review criteria and project conventions
  • Read full diff and existing PR conversation
  • Read the full changed file for surrounding context
  • Verify relative links resolve
  • Check for cross-skill references, secrets, and other issues
  • Post review

Summary

Fixes four stale fields in impl.md to align the HITL node Quick Reference JSON with what the CLI actually writes: removes spurious action from outcomes, strips description from instance outputs, adds the custom: true per-field entry, and corrects the status variable description.

Change-by-Change Review

1. skills/uipath-maestro-flow/references/author/references/plugins/hitl/impl.mdOK

Outcomes cleanup (lines 37-39): Removing "action": "Continue" / "action": "End" aligns with hitl-node-quickform.md (confirmed: no "action" field present there after #627). Correct.

Outputs description removal (lines 46-47, 126-131): Both Option 1 and Option 2 output blocks now omit description — consistent with the CLI generating instance-level outputs without descriptions (those live in outputDefinition). Correct.

custom: true entry (line 48, 53, 63): New <variable> placeholder entry with custom: true is documented with a concise prose note explaining $vars.<variable> global scope and when to omit. Correct and useful.

status description fix (line 62): Changed from "action value" ("Continue" / "End") to "outcome id" ("approve", "reject"). Matches the actual =result.Action resolved value. Correct.

What's Missing

  • Low — Placeholder case inconsistency: New placeholders <variable> and <fieldId> (line 48) use camelCase while the repo convention is <UPPER_SNAKE_CASE> (e.g., <DEFINITION_VERSION> on line 121). This is minor given these are JSON key/value placeholders (not CLI args) and match the {variable} / {fieldName} template style used in the output variables list on lines 60-63. Up to the author whether to normalize. Fix this →

Area Ratings

Area Status Notes
Frontmatter N/A No frontmatter changes
E2E Tests N/A Documentation-only fix, no new behavior
Skill Body N/A Changes are in a reference file
References & Assets OK All four fixes are accurate and well-scoped
Repo Hygiene OK No secrets, no cross-skill deps introduced, all links resolve

Issues for Manual Review

  • Confirm that =result.Action still resolves to the outcome id (e.g. "approve") rather than some other field — the PR's description says "outcome id" which matches the outcome objects' id values, but this is a domain-specific runtime behavior the reviewer cannot verify statically.

Conclusion

Clean, well-scoped fix. All four changes bring impl.md into alignment with the CLI contract and the previously-fixed hitl-node-quickform.md. Only a minor placeholder case note (Low). Approve.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants