Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .changeset/docs-task-completion-prefix-context-outputs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
---

docs(compliance): document task_completion.<inner> prefix for context_outputs.path

Adds a missing bullet to the storyboard-schema.yaml context_outputs runner-behavior
block explaining the task_completion.<inner> path prefix introduced in adcp-client v6.7
(adcp-client#1426). Documents the polling behavior, the result payload field, and
grading on non-success terminal statuses (failed/canceled/rejected →
capture_path_not_resolvable). No wire format changes; YAML comments only.
10 changes: 10 additions & 0 deletions static/compliance/source/universal/storyboard-schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,16 @@
# grade as skipped with reason: prerequisite_failed citing this step.
# See runner-output-contract.yaml > validation_result for the output shape.
# - The accumulator is storyboard-run-scoped; values do not leak across runs.
# - Special path prefix `task_completion.<inner>`: when the immediate
# response is a non-terminal task envelope (status submitted/working,
# with a task_id), the runner polls `tasks/get` until the task exits
# {submitted, working}. On `completed`: resolves <inner> against the
# `result` payload; a missing path grades this step as
# capture_path_not_resolvable. On any other status (failed, canceled,
# rejected, auth-required, input-required, unknown): `result` is absent;
# the capture grades as capture_path_not_resolvable on this step;
# downstream $context.<name> references grade as prerequisite_failed
# citing this step. See adcp-client#1426 for the implementation.
#
# context_inputs: array of ContextInput objects (optional — inject captured
# context values into the request at a specific path AFTER the per-task
Expand Down
Loading