@openwop/spec-artifacts 2.42.6 → 2.42.7

package/api/v2/asyncapi.yaml

@@ -1,11 +1,13 @@
 asyncapi: 3.1.0
 info:
   title: OpenWOP v2 event streams
-  version: 2.42.6
-  description: GENERATED by scripts/derive-v2-api.py (RFC 0171 §E.1, RFC 0172 §C.2). One run-events channel whose address
-    is the OpenAPI path key; the server pathname is empty (bare origin). streamMode is a pattern over the closed set and its
-    comma-separated combinations (`values` never combines). hostEvents has a real address (RFC 0171 §E.1) — the documented
-    default; a host MAY declare another under `heartbeat.deliveryChannel`.
+  version: 2.42.7
+  description: 'OpenWOP v2 event streams over SSE. The run-events channel''s address is the OpenAPI path key, and the server
+    pathname is empty (bare origin). `streamMode` is a stream mode from the closed set, or a comma-separated combination of
+    them; `values` never combines. `hostEvents` has a default address, `/host/events`; a host MAY declare another under `heartbeat.deliveryChannel`.
+
+
+    Generated from `api/asyncapi.yaml` by `scripts/derive-v2-api.py`; do not edit.'
 defaultContentType: text/event-stream
 servers:
   production:
@@ -21,13 +23,13 @@ channels:
     title: Run event stream (SSE)
     parameters:
       runId:
-        description: ids.schema.json#/$defs/runId
+        description: The run to subscribe to (`ids.schema.json#/$defs/runId`).
     messages:
       runEvent:
         $ref: '#/components/messages/RunEvent'
   hostEvents:
     address: /host/events
-    title: Host-scoped events (heartbeat.*)
+    title: Host-scoped events (`heartbeat.*`)
     messages:
       heartbeatEvaluated:
         $ref: '#/components/messages/HeartbeatEvaluated'
@@ -39,8 +41,8 @@ operations:
     channel:
       $ref: '#/channels/runEvents'
     title: Subscribe to a run's events
-    description: Long-lived SSE subscription; auto-closes on a terminal run event; `Last-Event-ID` resumes from the sequence
-      AFTER the supplied one. Mixed mode is union-of-filters with per-event `event:` labels (stream-modes).
+    description: A long-lived SSE subscription that closes after a terminal run event. `Last-Event-ID` resumes from the sequence
+      after the supplied one. A mixed mode is the union of its filters, and each event carries its own `event:` label (`stream-modes.md`).
     bindings:
       http:
         method: GET
@@ -66,98 +68,99 @@ components:
       type: http
       scheme: bearer
       bearerFormat: API key
-      description: 'Bearer API key, the same scheme as api/v2/openapi.yaml `ApiKeyAuth` (RFC 0200 §F). Required scope: `runs:read`
-        to subscribe.'
+      description: Bearer API key; the same scheme as `ApiKeyAuth` in `api/v2/openapi.yaml`. Subscribing requires the `runs:read`
+        scope.
   parameters:
     RunId:
       description: The run to subscribe to. Format opaque; clients MUST treat as a string.
   messages:
     EvalStarted:
       name: eval.started
-      title: Eval run started (RFC 0081)
-      summary: An eval run began. Content-free — suite provenance + counts only. Gated on capabilities.agents.evalSuite.supported.
+      title: Eval run started
+      summary: 'An eval run began. Content-free: suite provenance and counts only. Gated on `capabilities.agents.evalSuite.supported`.'
       contentType: application/json
       payload:
         $ref: '#/components/schemas/EvalStartedPayload'
     EvalScored:
       name: eval.scored
-      title: Eval task scored (RFC 0081)
-      summary: One eval task was scored (emitted per task, after its terminal agent.decided). Content-free — taskId + score
-        + scalars only, never task output (eval-summary-no-content-leak).
+      title: Eval task scored
+      summary: 'One eval task was scored, emitted per task after its terminal `agent.decided`. Content-free: `taskId`, score
+        and scalars only, never task output (`eval-summary-no-content-leak`).'
       contentType: application/json
       payload:
         $ref: '#/components/schemas/EvalScoredPayload'
     EvalCompleted:
       name: eval.completed
-      title: Eval run completed (RFC 0081)
-      summary: An eval run finished. Content-free aggregate scalars; the full scorecard is the run output, read via GET /runs/{runId}/eval-summary.
+      title: Eval run completed
+      summary: An eval run finished. Content-free aggregate scalars; the full scorecard is the run output, read with `GET
+        /runs/{runId}/eval-summary`.
       contentType: application/json
       payload:
         $ref: '#/components/schemas/EvalCompletedPayload'
     DeploymentPromoted:
       name: deployment.promoted
-      title: Deployment promoted (RFC 0082)
-      summary: A version was promoted into a new lifecycle state (gated by RFC 0049 deploy:* + RFC 0051 approvalGate + RFC
-        0081 requiredEval). Content-free (deployment-event-no-content-leak). Principal-stamped + audit-logged.
+      title: Deployment promoted
+      summary: A version was promoted into a new lifecycle state, gated by the `deploy:*` scope, the approvalGate, and `requiredEval`.
+        Content-free (`deployment-event-no-content-leak`); principal-stamped and audit-logged.
       contentType: application/json
       payload:
         $ref: '#/components/schemas/DeploymentPromotedPayload'
     DeploymentRolledBack:
       name: deployment.rolled-back
-      title: Deployment rolled back (RFC 0082)
+      title: Deployment rolled back
       summary: An active version was rolled back and a prior version restored. Content-free; recorded-fact; audit-logged.
       contentType: application/json
       payload:
         $ref: '#/components/schemas/DeploymentRolledBackPayload'
     DeploymentCanaryAdjusted:
       name: deployment.canary-adjusted
-      title: Deployment canary adjusted (RFC 0082)
+      title: Deployment canary adjusted
       summary: An active version's canary traffic share changed. Content-free; recorded-fact; audit-logged.
       contentType: application/json
       payload:
         $ref: '#/components/schemas/DeploymentCanaryAdjustedPayload'
     DeploymentStateChanged:
       name: deployment.state-changed
-      title: Deployment state changed (RFC 0082)
-      summary: A non-promotion lifecycle transition (pause / resume / deprecate). Content-free; recorded-fact; audit-logged.
+      title: Deployment state changed
+      summary: A non-promotion lifecycle transition (pause, resume, deprecate). Content-free; recorded-fact; audit-logged.
       contentType: application/json
       payload:
         $ref: '#/components/schemas/DeploymentStateChangedPayload'
     ProposalCreated:
       name: proposal.created
-      title: Proposal created (RFC 0096)
-      summary: The host synthesized a reviewable-learning draft. Content-free — ids/kind/refs only, never the artifact body
-        or rationale (proposal-inert-until-applied). Emitted only when capabilities.agents.proposals is advertised.
+      title: Proposal created
+      summary: 'The host synthesized a reviewable-learning draft. Content-free: ids, kind and refs only, never the artifact
+        body or rationale (`proposal-inert-until-applied`). Emitted only when `capabilities.agents.proposals` is advertised.'
       contentType: application/json
       payload:
         $ref: '#/components/schemas/ProposalCreatedPayload'
     ProposalActivated:
       name: proposal.activated
-      title: Proposal activated (RFC 0096)
-      summary: A proposal was applied (RFC 0051/0049-gated). Content-free; the installed artifact byte-matches the last-persisted
-        draft (proposal-no-resynthesis).
+      title: Proposal activated
+      summary: A proposal was applied, through its approval gate and authorization check. Content-free; the installed artifact
+        byte-matches the last-persisted draft (`proposal-no-resynthesis`).
       contentType: application/json
       payload:
         $ref: '#/components/schemas/ProposalActivatedPayload'
     GoalEvaluated:
       name: goal.evaluated
-      title: Goal evaluated (RFC 0097)
-      summary: A judge check ran against a standing goal. Content-free — no objective text; the verdict is recorded (not recomputed
-        on replay).
+      title: Goal evaluated
+      summary: 'A judge check ran against a standing goal. Content-free: no objective text. The verdict is recorded, not recomputed
+        on replay.'
       contentType: application/json
       payload:
         $ref: '#/components/schemas/GoalEvaluatedPayload'
     GoalClosed:
       name: goal.closed
-      title: Goal closed (RFC 0097)
-      summary: A standing goal stopped continuation (satisfied / escalated / abandoned / bound-exceeded). Content-free.
+      title: Goal closed
+      summary: A standing goal stopped continuation (satisfied, escalated, abandoned, or bound-exceeded). Content-free.
       contentType: application/json
       payload:
         $ref: '#/components/schemas/GoalClosedPayload'
     ImportApplied:
       name: import.applied
-      title: Import applied (RFC 0098)
-      summary: An estate import was applied. Content-free — counts + refs only, never item payloads or secret values (export-bundle-no-credential-material).
+      title: Import applied
+      summary: 'An estate import was applied. Content-free: counts and refs only, never item payloads or secret values (`export-bundle-no-credential-material`).'
       contentType: application/json
       payload:
         $ref: '#/components/schemas/ImportAppliedPayload'
@@ -191,37 +194,37 @@ components:
         $ref: '#/components/schemas/RunEventDoc'
     CompensationRequested:
       name: compensation.requested
-      title: Compensation plan persisted (RFC 0151 §C/§D)
-      summary: The unwind plan is durable. §C requires this BEFORE the first inverse action executes — a host that starts
-        unwinding first cannot resume after a crash, and the crash is when resumption matters.
+      title: Compensation plan persisted
+      summary: 'The unwind plan is durable. This event is required before the first inverse action executes: a host that starts
+        unwinding first cannot resume after a crash, and a crash is when resumption matters.'
       contentType: application/json
       payload:
         $ref: '#/components/schemas/RunEventDoc'
     CompensationStarted:
       name: compensation.started
-      title: First inverse action started (RFC 0151 §D)
-      summary: Compensation began executing. MUST follow compensation.requested.
+      title: First inverse action started
+      summary: Compensation began executing. MUST follow `compensation.requested`.
       contentType: application/json
       payload:
         $ref: '#/components/schemas/RunEventDoc'
     CompensationCompleted:
       name: compensation.completed
-      title: Compensation completed (RFC 0151 §D)
+      title: Compensation completed
       summary: Every inverse action in the plan succeeded.
       contentType: application/json
       payload:
         $ref: '#/components/schemas/RunEventDoc'
     CompensationFailed:
       name: compensation.failed
-      title: Compensation failed (RFC 0151 §D)
-      summary: An inverse action exhausted its retries. Compensation is a second effect, not an undo — it can fail, and the
-        run's compensationStatus records that rather than the run silently reporting success.
+      title: Compensation failed
+      summary: 'An inverse action exhausted its retries. Compensation is a second effect, not an undo: it can fail, and the
+        run''s `compensationStatus` records that rather than the run silently reporting success.'
       contentType: application/json
       payload:
         $ref: '#/components/schemas/RunEventDoc'
     CompensationPaused:
       name: compensation.paused
-      title: Compensation paused for authorized intervention (RFC 0151 §C)
+      title: Compensation paused for authorized intervention
       summary: Cancelling the parent MUST NOT silently abandon an active compensation. It continues, pauses here, or records
         manual intervention required.
       contentType: application/json
@@ -229,8 +232,8 @@ components:
         $ref: '#/components/schemas/RunEventDoc'
     CompensationManualInterventionRequired:
       name: compensation.manual-intervention-required
-      title: Compensation needs an operator (RFC 0151 §C/§E)
-      summary: The host cannot proceed unaided. Recorded explicitly because an unwind that stops without saying so is indistinguishable
+      title: Compensation needs an operator
+      summary: The host cannot proceed unaided. Recorded explicitly, because an unwind that stops without saying so is indistinguishable
         from one that finished.
       contentType: application/json
       payload:
@@ -251,32 +254,32 @@ components:
         $ref: '#/components/schemas/RunEventDoc'
     RunAnnotated:
       name: run.annotated
-      title: Run annotated (RFC 0056)
-      summary: A non-blocking quality annotation was recorded for the run. Live notification ONLY — NOT a replayable run-event-log
-        entry; its payload is an Annotation (not a RunEventDoc), so it is excluded from fork/replay (RFC 0056 §B/§D).
+      title: Run annotated
+      summary: 'A non-blocking quality annotation was recorded for the run. Live notification only, not a replayable run-event-log
+        entry: its payload is an `Annotation`, not a `RunEventDoc`, so it is excluded from fork and replay.'
       contentType: application/json
       payload:
         $ref: '#/components/schemas/Annotation'
     WorkspaceUpdated:
       name: workspace.updated
-      title: Workspace file updated (RFC 0059)
-      summary: A workspace file was created, replaced, or deleted via the host.workspace store. Content-free — carries the
-        file path + resulting version only (the body is served by the read-side, SR-1-redacted). A replayable run-event-log
-        entry (re-read from the log on replay, never regenerated); gated on capabilities.workspace.supported.
+      title: Workspace file updated
+      summary: 'A workspace file was created, replaced, or deleted through the `host.workspace` store. Content-free: it carries
+        the file path and resulting version only; the body is served by the read side, SR-1-redacted. A replayable run-event-log
+        entry, re-read from the log on replay and never regenerated. Gated on `capabilities.workspace.supported`.'
       contentType: application/json
       payload:
         $ref: '#/components/schemas/WorkspaceUpdatedPayload'
     HeartbeatEvaluated:
       name: heartbeat.evaluated
-      title: Heartbeat evaluated (RFC 0060)
-      summary: A heartbeat predicate was evaluated this tick (status + changed flag). Heartbeat-scoped observability.
+      title: Heartbeat evaluated
+      summary: A heartbeat predicate was evaluated this tick (status and a changed flag). Heartbeat-scoped observability.
       contentType: application/json
       payload:
         $ref: '#/components/schemas/HeartbeatEvaluated'
     HeartbeatStateChanged:
       name: heartbeat.stateChanged
-      title: Heartbeat state changed (RFC 0060)
-      summary: A heartbeat predicate's state transitioned; emitted ONLY on change (never on an unchanged tick). Heartbeat-scoped.
+      title: Heartbeat state changed
+      summary: A heartbeat predicate's state transitioned. Emitted only on a change, never on an unchanged tick. Heartbeat-scoped.
       contentType: application/json
       payload:
         $ref: '#/components/schemas/HeartbeatStateChanged'
@@ -306,23 +309,23 @@ components:
         $ref: '#/components/schemas/RunEventDoc'
     NodeDispatched:
       name: node.dispatched
-      title: core.dispatch spawned a child workflow (RFC 0007 §D + RFC 0022 §A)
+      title: '`core.dispatch` spawned a child workflow'
       contentType: application/json
       payload:
         $ref: '#/components/schemas/RunEventDoc'
     DispatchFanOut:
       name: dispatch.fanned-out
-      title: core.dispatch began a parallel fan-out wave (RFC 0118)
-      summary: Emitted when a fanOutPolicy=parallel wave begins; payload $defs.dispatchFanOut carries childCount/maxConcurrency/joinMode.
-        Parallel path only.
+      title: '`core.dispatch` began a parallel fan-out wave'
+      summary: Emitted when a `fanOutPolicy=parallel` wave begins; the payload (`$defs.dispatchFanOut`) carries `childCount`,
+        `maxConcurrency` and `joinMode`. Parallel path only.
       contentType: application/json
       payload:
         $ref: '#/components/schemas/RunEventDoc'
     DispatchJoin:
       name: dispatch.joined
-      title: core.dispatch parallel join satisfied (RFC 0118)
-      summary: Emitted when a fanOutPolicy=parallel join is satisfied/failed; payload $defs.dispatchJoin carries joinOutcome
-        + the replay-deterministic mergeOrder.
+      title: '`core.dispatch` parallel join satisfied'
+      summary: Emitted when a `fanOutPolicy=parallel` join is satisfied or failed; the payload (`$defs.dispatchJoin`) carries
+        `joinOutcome` and the replay-deterministic `mergeOrder`.
       contentType: application/json
       payload:
         $ref: '#/components/schemas/RunEventDoc'
@@ -355,21 +358,9 @@ components:
     InterruptRequested:
       name: interrupt.requested
       title: Interrupt requested (canonical HITL primitive)
-      summary: 'The discriminated-union form of the full `interrupt.md` kind union
-
-        (RFC 0094 §E): approval / clarification / external-event / custom /
-
-        conversation.start / conversation.exchange / conversation.close /
-
-        low-confidence.
-
-        Servers emitting `interrupt.requested` SHOULD also emit the legacy
-
-        kind-specific event (`approval.requested` etc) for backward compat
-
-        until consumers migrate.
-
-        '
+      summary: 'The discriminated-union form of the full `interrupt.md` kind union: approval, clarification, external-event,
+        custom, conversation.start, conversation.exchange, conversation.close, low-confidence. Servers emitting `interrupt.requested`
+        SHOULD also emit the kind-specific event (`approval.requested` etc.) until consumers migrate.'
       contentType: application/json
       payload:
         $ref: '#/components/schemas/RunEventDoc'
@@ -389,13 +380,8 @@ components:
     StateSnapshot:
       name: state.snapshot
       title: Full projected run state
-      summary: 'Synthesized event emitted by the server in `values` mode after
-
-        each `updates`-tier transition. NOT a member of the canonical
-
-        `RunEventType` enum — this is a per-mode synthetic.
-
-        '
+      summary: Synthesized event the server emits in `values` mode after each `updates`-tier transition. It is not a member
+        of the canonical `RunEventType` enum; it is a per-mode synthetic.
       contentType: application/json
       payload:
         $ref: '#/components/schemas/StateSnapshotPayload'
@@ -409,27 +395,11 @@ components:
     AnyRunEvent:
       name: any
       title: Any RunEventDoc
-      summary: 'Type-erased handler for `debug` mode — discriminate on the
-
-        `type` field per the `RunEventType` enum in the run-event
-
-        JSON Schema (the authoritative, exhaustive event list; the
-
-        named messages above are a curated `updates`-tier subset).
-
-        Includes events filtered out of `updates`: `log.appended`,
-
-        `variable.changed`, `version.pinned`, `lease.*`, `node.retried`,
-
-        `replay.diverged`, `connector.authorized`,
-
-        `connector.auth_expired` (RFC 0047), `authorization.decided`
-
-        (RFC 0049), `approval.granted` / `approval.rejected` /
-
-        `approval.overridden` (RFC 0051), etc.
-
-        '
+      summary: 'Type-erased handler for `debug` mode. Discriminate on the `type` field using the `RunEventType` enum in the
+        run-event JSON Schema, the authoritative and exhaustive event list; the named messages above are a curated `updates`-tier
+        subset. Includes events filtered out of `updates`: `log.appended`, `variable.changed`, `version.pinned`, `lease.*`,
+        `node.retried`, `replay.diverged`, `connector.authorized`, `connector.auth_expired`, `authorization.decided`, `approval.granted`
+        / `approval.rejected` / `approval.overridden`, etc.'
       contentType: application/json
       payload:
         $ref: '#/components/schemas/RunEventDoc'
@@ -477,11 +447,11 @@ components:
         $ref: '#/components/schemas/RunEventDoc'
     RunEvent:
       name: runEvent
-      title: Run event (RFC 0171 §A)
+      title: Run event
       contentType: text/event-stream
       payload:
         $ref: ../../schemas/v2/run-event.schema.json
-      description: One SSE frame per run event; `event:` is the v2 type, `id:` is the sequence (RFC 0171 §A.3).
+      description: 'One SSE frame per run event: `event:` is the v2 type and `id:` is the sequence.'
   schemas:
     RunEventDoc:
       $ref: ../../schemas/v2/run-event.schema.json