@openwop/openwop-conformance 1.21.0 → 1.23.0

package/api/asyncapi.yaml

@@ -2,12 +2,12 @@ asyncapi: 3.1.0
 
 info:
   title: Workflow Orchestration Protocol (openwop) SSE Event Stream
-  version: "1.0"
+  version: "1.1.0"
   externalDocs:
     description: openwop spec v1 corpus
     url: https://openwop.dev/spec/v1/
   description: |
-    Canonical AsyncAPI 3.0 specification for the openwop server's
+    Canonical AsyncAPI 3.1.0 specification for the openwop server's
     Server-Sent Events surface. Formalizes `stream-modes.md`
     and references the run-event JSON Schema via `$ref` so external SDK
     authors can codegen typed consumers without re-reading the prose.
@@ -55,18 +55,27 @@ servers:
 channels:
 
   heartbeatEvents:
-    address: /heartbeats/{heartbeatId}/events
+    # Logical channel — `address: null` per AsyncAPI 3.x ("address not
+    # applicable / host-defined"). RFC 0094 §I: host-capabilities.md
+    # §host.heartbeat defines the two heartbeat events but documents NO
+    # HTTP delivery path for them (they are heartbeat-scoped, NOT
+    # run-event-log entries, so they do not ride /runs/{runId}/events
+    # either). The previous `/heartbeats/{heartbeatId}/events` address
+    # implied an undocumented REST surface; the delivery transport is a
+    # host concern until an RFC specifies one.
+    address: null
     title: Heartbeat evaluation events (RFC 0060)
-    summary: Per-tick heartbeat evaluation + state-change notifications.
+    summary: Per-tick heartbeat evaluation + state-change notifications (logical channel).
     description: |
       RFC 0060 `host.heartbeat`. Heartbeat-scoped (NOT a run-event
       stream): a host advertising `capabilities.heartbeat.supported: true`
       emits `heartbeat.evaluated` every tick and `heartbeat.stateChanged`
       only on a predicate-state transition. Both are observability-only;
       consumers MAY ignore them.
-    parameters:
-      heartbeatId:
-        description: Host-assigned heartbeat identifier.
+
+      LOGICAL channel: `host-capabilities.md` §host.heartbeat documents
+      the event shapes but no HTTP address; how a host delivers them
+      (webhook, host-internal bus, vendor stream) is host-defined.
     messages:
       heartbeatEvaluated:    { $ref: '#/components/messages/HeartbeatEvaluated' }
       heartbeatStateChanged: { $ref: '#/components/messages/HeartbeatStateChanged' }
@@ -200,6 +209,13 @@ operations:
       for resumption — server begins streaming from the sequence
       AFTER the supplied ID and MUST NOT re-emit the resumption
       point itself.
+
+      Mixed mode (RFC 0094 §I note): the binding's single-value
+      `streamMode` enum below describes THIS mode's pure subscription;
+      `streamMode` additionally accepts comma-separated combinations
+      (e.g. `updates,messages`) per `stream-modes.md` §"Mixed mode" —
+      union-of-filters semantics, per-event `event:` labels.
+      `values` MUST NOT combine with other modes.
     bindings:
       http:
         method: GET
@@ -217,6 +233,11 @@ operations:
       $ref: '#/channels/runEventsValues'
     title: Subscribe to values stream
     summary: Receive full state snapshots after every transition.
+    description: |
+      Mixed mode (RFC 0094 §I note): `values` is EXCLUSIVE — it MUST NOT
+      be combined in a comma-separated `streamMode` list
+      (`stream-modes.md` §"Mixed mode": state.snapshot semantics need
+      exclusive ownership). The binding's single-value enum is exact here.
     bindings:
       http:
         method: GET
@@ -234,6 +255,12 @@ operations:
       $ref: '#/channels/runEventsMessages'
     title: Subscribe to messages stream
     summary: Receive per-token AI chunks.
+    description: |
+      Mixed mode (RFC 0094 §I note): the binding's single-value
+      `streamMode` enum below describes the pure `messages` subscription;
+      `streamMode` additionally accepts comma-separated combinations
+      (e.g. `updates,messages`) per `stream-modes.md` §"Mixed mode".
+      `values` MUST NOT combine with other modes.
     bindings:
       http:
         method: GET
@@ -251,6 +278,12 @@ operations:
       $ref: '#/channels/runEventsDebug'
     title: Subscribe to debug stream
     summary: Receive every engine event including internal/log/lease.
+    description: |
+      Mixed mode (RFC 0094 §I note): the binding's single-value
+      `streamMode` enum below describes the pure `debug` subscription;
+      `streamMode` additionally accepts comma-separated combinations
+      (e.g. `updates,debug`) per `stream-modes.md` §"Mixed mode".
+      `values` MUST NOT combine with other modes.
     bindings:
       http:
         method: GET
@@ -496,7 +529,10 @@ components:
       name: interrupt.requested
       title: Interrupt requested (canonical HITL primitive)
       summary: |
-        The discriminated-union form of approval/clarification/external-event/custom.
+        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.
@@ -605,33 +641,13 @@ components:
       $ref: '../schemas/run-snapshot.schema.json'
 
     AiMessageChunkPayload:
-      # S2 closure (2026-04-27): tiered metadata. Bare {nodeId, runId,
-      # chunk, isLast} is the minimum compliant payload; `meta`
-      # adds Tier 1 typed slots (finishReason / logprobs / toolCalls /
-      # model / usage) and a Tier 2 provider-pass-through escape hatch.
-      # Schema definition lives at run-event-payloads.schema.json#$defs.outputChunk
-      # — referenced here verbatim so the SSE consumer + run-event log
-      # share a single shape contract.
-      type: object
-      required: [nodeId, runId, chunk, isLast]
-      properties:
-        nodeId: { type: string }
-        runId: { type: string }
-        chunk:
-          type: string
-          description: The new token(s) since the previous chunk.
-        isLast:
-          type: boolean
-          description: True for the final chunk of a given AI node call.
-        meta:
-          type: object
-          description: |
-            Tiered metadata. Tier 1: typed slots — `finishReason`
-            ("stop"|"length"|"tool_calls"|"content_filter"), `logprobs`,
-            `toolCalls`, `model`, `usage` ({promptTokens,
-            completionTokens, totalTokens}). Tier 2: provider-pass-through
-            via `provider` + `providerExtensions`. Consumers SHOULD prefer
-            Tier 1; Tier 2 is the escape hatch for fields the spec hasn't
-            typed yet. See run-event-payloads.schema.json#$defs._chunkMeta
-            for the full definition + per-field constraints.
-          additionalProperties: true
+      # S2 closure (2026-04-27) + RFC 0094 §D single-sourcing: the payload
+      # is the canonical `outputChunk` definition in
+      # run-event-payloads.schema.json — referenced (not hand-copied, the
+      # prior inline copy was one of the three drifting definitions) so the
+      # SSE consumer + run-event log share exactly one shape contract.
+      # Minimum compliant payload: {nodeId, runId, chunk, isLast} per
+      # stream-modes.md §messages; `meta` adds Tier 1 typed slots
+      # (finishReason / logprobs / toolCalls / model / usage) and a Tier 2
+      # provider-pass-through escape hatch (see #$defs/_chunkMeta).
+      $ref: '../schemas/run-event-payloads.schema.json#/$defs/outputChunk'

package/api/openapi.yaml

@@ -2,7 +2,7 @@ openapi: 3.1.0
 
 info:
   title: Workflow Orchestration Protocol (openwop) API
-  version: "1.0"
+  version: "1.1.0"
   summary: REST surface for declaring, executing, suspending, resuming, and observing multi-step workflows.
   description: |
     Canonical OpenAPI 3.1 specification for openwop-compliant servers. Generated from `rest-endpoints.md` and references the JSON Schemas in `schemas/`.
@@ -16,6 +16,16 @@ info:
     - `run-options.md` — `configurable`/`tags`/`metadata`
     - `interrupt.md` — HITL primitive
     - `replay.md` — `:fork` endpoint
+
+    **Registry scope (RFC 0094 §I).** This document specifies the HOST
+    surface. The production node-pack registry surface (`/v1/packs/*` —
+    publish/get/delete/sig, deprecation, yank, key rotation) is specified in
+    `spec/v1/node-packs.md` §"Registry HTTP API" + `spec/v1/registry-operations.md`
+    and is served by a registry service (e.g. the planned hosted reference
+    registry `packs.openwop.dev`, or a third-party/private registry
+    implementation) — a distinct deployable, out of scope for this host
+    OpenAPI document. Only the test-mode mirror (`/v1/packs-test/*`, RFC 0025)
+    is host-mounted and documented here.
   contact:
     name: openwop spec working group
     url: https://openwop.dev/spec/v1/
@@ -75,6 +85,11 @@ tags:
       19-code publish error catalog without `packs:publish` scope on the real registry. Hosts that haven't
       mounted this surface MUST return `404 Not Found` for every path under `/v1/packs-test/`.
 
+      Scope note (RFC 0094 §I): the PRODUCTION `/v1/packs/*` surface these paths mirror is specified in
+      `spec/v1/registry-operations.md` + `node-packs.md` §"Registry HTTP API" and is served by a registry
+      service (a distinct deployable from the host), so it is intentionally NOT defined in this host
+      OpenAPI document.
+
 # ─────────────────────────────────────────────────────────────────────────────
 # PATHS
 # ─────────────────────────────────────────────────────────────────────────────
@@ -178,7 +193,13 @@ paths:
               # routing fields, plus the openwop RunOptions overlay (configurable,
               # tags, metadata) hoisted into a first-class JSON Schema at
               # ../schemas/run-options.schema.json. allOf composes the two
-              # so callers see one unified body shape.
+              # so callers see one unified body shape. RFC 0094 §A: neither
+              # allOf branch is closed via additionalProperties (two closed
+              # branches inside one allOf made every documented body
+              # unsatisfiable); the composed request is closed here with
+              # `unevaluatedProperties: false` (JSON Schema 2020-12), so
+              # undeclared properties still fail at the composition level.
+              unevaluatedProperties: false
               allOf:
                 - type: object
                   properties:
@@ -215,7 +236,6 @@ paths:
                       type: string
                       minLength: 1
                       description: RFC 0081 — the manifest agent the eval suite targets. Required when mode is `eval`.
-                  additionalProperties: false
                   if:
                     properties: { mode: { const: eval } }
                     required: [mode]
@@ -1843,6 +1863,9 @@ paths:
         `conflict`/`version_conflict`) MUST be served verbatim. The
         test catalog MUST be isolated per RFC 0025 §C — a pack PUT'd
         here MUST NOT appear in `GET /v1/packs/{name}` listings.
+        The mirrored production path is registry-service surface
+        (`registry-operations.md`), not defined in this host document
+        (see the `packs-test` tag scope note).
       operationId: putTestPackTarball
       parameters:
         - in: header
@@ -1914,7 +1937,7 @@ paths:
     get:
       tags: [packs-test]
       summary: Fetch a published test-catalog tarball.
-      description: 'Mirror of `GET /v1/packs/{name}/-/{version}.tgz`. Returns the gzipped tarball bytes with `Content-Type: application/tar+gzip` and an `ETag: "sha256-..."` matching the manifest''s `tarballSha256`.'
+      description: 'Mirror of `GET /v1/packs/{name}/-/{version}.tgz`. Returns the gzipped tarball bytes with `Content-Type: application/tar+gzip` and an `ETag: "sha256-..."` matching the manifest''s `tarballSha256`. The mirrored production path is registry-service surface (`registry-operations.md`), not defined in this host document (see the `packs-test` tag scope note).'
       operationId: getTestPackTarball
       responses:
         '200':
@@ -1951,7 +1974,10 @@ paths:
         for versions older than the registry's unpublish window
         (default 72h). Test-mode implementations MAY shorten the
         window for tractable conformance fixtures but MUST surface
-        the same error code.
+        the same error code. The mirrored production path is
+        registry-service surface (`registry-operations.md`), not
+        defined in this host document (see the `packs-test` tag
+        scope note).
       operationId: deleteTestPackVersion
       responses:
         '204':
@@ -1983,7 +2009,9 @@ paths:
       description: |
         Mirror of `GET /v1/packs/{name}/-/{version}.sig`. Returns the
         signature blob over `pack.json` for this version. MAY 302-redirect
-        to a storage-backend signed URL.
+        to a storage-backend signed URL. The mirrored production path is
+        registry-service surface (`registry-operations.md`), not defined
+        in this host document (see the `packs-test` tag scope note).
       operationId: getTestPackSignature
       responses:
         '200':