docs: document interrupt resume contracts
This commit is contained in:
@@ -37,8 +37,8 @@ Design contracts:
|
||||
|
||||
Implementation order:
|
||||
|
||||
1. Add self-describing interrupt request/resume schemas to the core run/inspect
|
||||
contract.
|
||||
1. Completed: self-describing interrupt request/resume schemas are carried
|
||||
through core execution, persisted run inspection, and resume validation.
|
||||
2. Add a deterministic `examples/lda_report_workflow/` case study with local
|
||||
document, report, and issue-board sources.
|
||||
3. Add a top-level `web/` Astro/Effect app with loopback JSON-RPC connection and
|
||||
|
||||
@@ -630,6 +630,17 @@ wf run trace run_123 --from 0 --limit 25
|
||||
|
||||
Trace output can be large. Always request a bounded range.
|
||||
|
||||
### Interrupt Resume Schemas
|
||||
|
||||
Interrupted runs may include `interrupt.request_schema` and
|
||||
`interrupt.resume_schema` in `wf run inspect` output. The request schema
|
||||
describes the payload shown to the operator. The resume schema describes the
|
||||
payload accepted by `wf run resume --payload` or `--payload-file`.
|
||||
|
||||
Resume payload validation happens before workflow state mutation. If validation
|
||||
fails, inspect the schema and retry with a payload that matches the declared
|
||||
shape.
|
||||
|
||||
## Explain
|
||||
|
||||
Explain stable diagnostic/error codes:
|
||||
|
||||
Reference in New Issue
Block a user