docs: document interrupt resume contracts
This commit is contained in:
@@ -125,6 +125,9 @@ top-level `compiled_plan` key from the CLI output.
|
||||
|
||||
## Rules
|
||||
|
||||
- For interrupted runs, call `wf run inspect <run_id>` before resuming. If the
|
||||
interrupt includes `resume_schema`, shape `wf run resume --payload` to that
|
||||
schema instead of guessing field names.
|
||||
- Use explicit `--config <path>` for examples, challenge workspaces, and
|
||||
non-root configs. The default is `wf.config.json` in the current working
|
||||
directory.
|
||||
|
||||
@@ -100,3 +100,10 @@ completed or failed runs. Use:
|
||||
- `wf run resume <run_id>` only for interrupted runs.
|
||||
|
||||
Do not ask for unbounded traces.
|
||||
|
||||
## Interrupt Resume Contracts
|
||||
|
||||
An interrupted run can carry a self-describing resume contract. Treat
|
||||
`interrupt.resume_schema` from `wf run inspect` as the source of truth for the
|
||||
payload you pass to `wf run resume`. Do not read workflow source code just to
|
||||
guess approval fields when the schema is present.
|
||||
|
||||
Reference in New Issue
Block a user