@openwop/spec-artifacts 2.0.0-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CORPUS-STAMP.json +234 -0
- package/LICENSE +201 -0
- package/README.md +7 -0
- package/api/.redocly.lint-ignore.yaml +22 -0
- package/api/asyncapi.yaml +834 -0
- package/api/grpc/openwop.proto +251 -0
- package/api/openapi.yaml +2693 -0
- package/api/redocly.yaml +23 -0
- package/api/seams-v2.yaml +680 -0
- package/api/v2/asyncapi.yaml +528 -0
- package/api/v2/openapi.yaml +3139 -0
- package/api/v2/redocly.yaml +16 -0
- package/package.json +10 -0
- package/schemas/README.md +144 -0
- package/schemas/a2a-task-state.schema.json +78 -0
- package/schemas/a2ui-surface-delta-frame.schema.json +48 -0
- package/schemas/agent-deployment-transition.schema.json +49 -0
- package/schemas/agent-deployment.schema.json +54 -0
- package/schemas/agent-eval-suite.schema.json +140 -0
- package/schemas/agent-inventory-response.schema.json +115 -0
- package/schemas/agent-manifest.schema.json +156 -0
- package/schemas/agent-org-chart.schema.json +82 -0
- package/schemas/agent-ref.schema.json +63 -0
- package/schemas/agent-roster-entry.schema.json +81 -0
- package/schemas/agent-roster-response.schema.json +21 -0
- package/schemas/ai-envelope.schema.json +134 -0
- package/schemas/annotation-create.schema.json +37 -0
- package/schemas/annotation.schema.json +56 -0
- package/schemas/artifact-type-pack-manifest.schema.json +244 -0
- package/schemas/audit-verify-result.schema.json +90 -0
- package/schemas/budget-policy.schema.json +18 -0
- package/schemas/capabilities.schema.json +4160 -0
- package/schemas/certification-bundle-v2.schema.json +118 -0
- package/schemas/channel-presence-payload.schema.json +41 -0
- package/schemas/channel-written-payload.schema.json +55 -0
- package/schemas/chat-card-pack-manifest.schema.json +253 -0
- package/schemas/compact-tool-descriptor.schema.json +51 -0
- package/schemas/compensation-policy.schema.json +64 -0
- package/schemas/conformance-certification-bundle.schema.json +86 -0
- package/schemas/connection-pack-manifest.schema.json +353 -0
- package/schemas/conversation-event.schema.json +168 -0
- package/schemas/conversation-turn.schema.json +117 -0
- package/schemas/core-conformance-mock-agent-config.schema.json +152 -0
- package/schemas/credential-provenance.schema.json +18 -0
- package/schemas/credential-reference.schema.json +21 -0
- package/schemas/debug-bundle.schema.json +196 -0
- package/schemas/dispatch-config.schema.json +112 -0
- package/schemas/envelopes/clarification.request.schema.json +52 -0
- package/schemas/envelopes/error.schema.json +30 -0
- package/schemas/envelopes/media.audio.schema.json +38 -0
- package/schemas/envelopes/media.file.schema.json +37 -0
- package/schemas/envelopes/media.image.schema.json +33 -0
- package/schemas/envelopes/schema.request.schema.json +26 -0
- package/schemas/envelopes/schema.response.schema.json +22 -0
- package/schemas/envelopes/ui.a2ui-surface.schema.json +154 -0
- package/schemas/error-envelope.schema.json +25 -0
- package/schemas/eval-summary.schema.json +92 -0
- package/schemas/export-bundle.schema.json +66 -0
- package/schemas/form-content-pack-manifest.schema.json +243 -0
- package/schemas/frontend-plugin-manifest.schema.json +109 -0
- package/schemas/goal.schema.json +104 -0
- package/schemas/heartbeat-evaluated.schema.json +14 -0
- package/schemas/heartbeat-state-changed.schema.json +14 -0
- package/schemas/localized-content-language-settings.schema.json +26 -0
- package/schemas/localized-content-page-response.schema.json +60 -0
- package/schemas/localized-content-page.schema.json +62 -0
- package/schemas/localized-content-section.schema.json +51 -0
- package/schemas/memory-entry.schema.json +36 -0
- package/schemas/memory-list-options.schema.json +37 -0
- package/schemas/node-pack-manifest.schema.json +654 -0
- package/schemas/orchestrator-decision.schema.json +90 -0
- package/schemas/org-chart-responsibility-view.schema.json +26 -0
- package/schemas/pack-lockfile.schema.json +108 -0
- package/schemas/prompt-kind.schema.json +8 -0
- package/schemas/prompt-pack-manifest.schema.json +117 -0
- package/schemas/prompt-ref.schema.json +40 -0
- package/schemas/prompt-template.schema.json +149 -0
- package/schemas/proposal.schema.json +84 -0
- package/schemas/registry-version-manifest.schema.json +208 -0
- package/schemas/residency.schema.json +16 -0
- package/schemas/run-ancestry-response.schema.json +54 -0
- package/schemas/run-diff-response.schema.json +64 -0
- package/schemas/run-event-payloads.schema.json +4452 -0
- package/schemas/run-event.schema.json +211 -0
- package/schemas/run-options.schema.json +80 -0
- package/schemas/run-orchestrator-decided-event.schema.json +20 -0
- package/schemas/run-snapshot.schema.json +148 -0
- package/schemas/security-advisory.schema.json +109 -0
- package/schemas/self-hosted-runner-dispatch-frame.schema.json +79 -0
- package/schemas/self-hosted-runner-registration.schema.json +53 -0
- package/schemas/self-hosted-runner-result-frame.schema.json +38 -0
- package/schemas/subject.schema.json +56 -0
- package/schemas/suspend-request.schema.json +207 -0
- package/schemas/tool-descriptor.schema.json +63 -0
- package/schemas/trigger-event.schema.json +222 -0
- package/schemas/trigger-subscription-registration.schema.json +67 -0
- package/schemas/trigger-subscription.schema.json +26 -0
- package/schemas/ui-plugin-message.schema.json +90 -0
- package/schemas/v2/a2a-task-state.schema.json +102 -0
- package/schemas/v2/a2ui-surface-delta-frame.schema.json +62 -0
- package/schemas/v2/agent-deployment-transition.schema.json +67 -0
- package/schemas/v2/agent-deployment.schema.json +68 -0
- package/schemas/v2/agent-eval-suite.schema.json +214 -0
- package/schemas/v2/agent-inventory-response.schema.json +172 -0
- package/schemas/v2/agent-manifest.schema.json +218 -0
- package/schemas/v2/agent-org-chart.schema.json +149 -0
- package/schemas/v2/agent-ref.schema.json +67 -0
- package/schemas/v2/agent-roster-entry.schema.json +104 -0
- package/schemas/v2/agent-roster-response.schema.json +27 -0
- package/schemas/v2/ai-envelope.schema.json +167 -0
- package/schemas/v2/annotation-create.schema.json +109 -0
- package/schemas/v2/annotation.schema.json +142 -0
- package/schemas/v2/artifact-type-pack-manifest.schema.json +245 -0
- package/schemas/v2/audit-verify-result.schema.json +110 -0
- package/schemas/v2/budget-policy.schema.json +61 -0
- package/schemas/v2/capabilities.schema.json +7644 -0
- package/schemas/v2/certification-bundle.schema.json +401 -0
- package/schemas/v2/channel-presence-payload.schema.json +60 -0
- package/schemas/v2/channel-written-payload.schema.json +64 -0
- package/schemas/v2/chat-card-pack-manifest.schema.json +254 -0
- package/schemas/v2/compact-tool-descriptor.schema.json +108 -0
- package/schemas/v2/compensation-policy.schema.json +91 -0
- package/schemas/v2/compensation-projection.schema.json +95 -0
- package/schemas/v2/configurable.schema.json +110 -0
- package/schemas/v2/connection-pack-manifest.schema.json +354 -0
- package/schemas/v2/conversation-event.schema.json +281 -0
- package/schemas/v2/conversation-turn.schema.json +165 -0
- package/schemas/v2/credential-provenance.schema.json +62 -0
- package/schemas/v2/credential-reference.schema.json +28 -0
- package/schemas/v2/debug-bundle.schema.json +312 -0
- package/schemas/v2/dispatch-config.schema.json +147 -0
- package/schemas/v2/effect-ledger-projection.schema.json +71 -0
- package/schemas/v2/effect-seam-manifest.schema.json +98 -0
- package/schemas/v2/envelopes/clarification.request.schema.json +59 -0
- package/schemas/v2/envelopes/error.schema.json +35 -0
- package/schemas/v2/envelopes/media.audio.schema.json +41 -0
- package/schemas/v2/envelopes/media.file.schema.json +40 -0
- package/schemas/v2/envelopes/media.image.schema.json +36 -0
- package/schemas/v2/envelopes/schema.request.schema.json +29 -0
- package/schemas/v2/envelopes/schema.response.schema.json +26 -0
- package/schemas/v2/envelopes/ui.a2ui-surface.schema.json +292 -0
- package/schemas/v2/error-envelope.schema.json +229 -0
- package/schemas/v2/eval-summary.schema.json +166 -0
- package/schemas/v2/export-bundle.schema.json +94 -0
- package/schemas/v2/form-content-pack-manifest.schema.json +241 -0
- package/schemas/v2/frontend-plugin-manifest.schema.json +152 -0
- package/schemas/v2/goal.schema.json +188 -0
- package/schemas/v2/heartbeat-evaluated.schema.json +34 -0
- package/schemas/v2/heartbeat-state-changed.schema.json +31 -0
- package/schemas/v2/ids.schema.json +31 -0
- package/schemas/v2/localized-content-language-settings.schema.json +34 -0
- package/schemas/v2/localized-content-page-response.schema.json +94 -0
- package/schemas/v2/localized-content-page.schema.json +87 -0
- package/schemas/v2/localized-content-section.schema.json +63 -0
- package/schemas/v2/memory-entry.schema.json +45 -0
- package/schemas/v2/memory-list-options.schema.json +41 -0
- package/schemas/v2/node-pack-manifest.schema.json +657 -0
- package/schemas/v2/orchestrator-decision.schema.json +120 -0
- package/schemas/v2/org-chart-responsibility-view.schema.json +36 -0
- package/schemas/v2/pack-lockfile.schema.json +139 -0
- package/schemas/v2/prompt-kind.schema.json +14 -0
- package/schemas/v2/prompt-pack-manifest.schema.json +118 -0
- package/schemas/v2/prompt-ref.schema.json +42 -0
- package/schemas/v2/prompt-template.schema.json +209 -0
- package/schemas/v2/proposal.schema.json +145 -0
- package/schemas/v2/registry-version-manifest.schema.json +292 -0
- package/schemas/v2/residency.schema.json +19 -0
- package/schemas/v2/run-ancestry-response.schema.json +68 -0
- package/schemas/v2/run-diff-response.schema.json +80 -0
- package/schemas/v2/run-event-payloads.schema.json +4588 -0
- package/schemas/v2/run-event.schema.json +324 -0
- package/schemas/v2/run-options.schema.json +90 -0
- package/schemas/v2/run-orchestrator-decided-event.schema.json +22 -0
- package/schemas/v2/run-snapshot.schema.json +207 -0
- package/schemas/v2/security-advisory.schema.json +138 -0
- package/schemas/v2/self-hosted-runner-dispatch-frame.schema.json +119 -0
- package/schemas/v2/self-hosted-runner-registration.schema.json +74 -0
- package/schemas/v2/self-hosted-runner-result-frame.schema.json +47 -0
- package/schemas/v2/subject-link.schema.json +69 -0
- package/schemas/v2/subject.schema.json +597 -0
- package/schemas/v2/suspend-request.schema.json +370 -0
- package/schemas/v2/tool-descriptor.schema.json +150 -0
- package/schemas/v2/trigger-event.schema.json +508 -0
- package/schemas/v2/trigger-subscription-registration.schema.json +99 -0
- package/schemas/v2/trigger-subscription.schema.json +79 -0
- package/schemas/v2/ui-plugin-message.schema.json +149 -0
- package/schemas/v2/workflow-chain-pack-manifest.schema.json +610 -0
- package/schemas/v2/workflow-definition.schema.json +864 -0
- package/schemas/v2/workload-identity.schema.json +115 -0
- package/schemas/v2/workspace-file-create.schema.json +23 -0
- package/schemas/v2/workspace-file.schema.json +45 -0
- package/schemas/workflow-chain-pack-manifest.schema.json +615 -0
- package/schemas/workflow-definition.schema.json +850 -0
- package/schemas/workload-identity.schema.json +79 -0
- package/schemas/workspace-file-create.schema.json +20 -0
- package/schemas/workspace-file.schema.json +39 -0
- package/spec/v1/alias-detectors.json +283 -0
- package/spec/v1/capability-declaration-classes.json +176 -0
- package/spec/v1/core-standard-manifest.json +423 -0
- package/spec/v1/deprecations.json +854 -0
- package/spec/v1/deprecations.schema.json +187 -0
- package/spec/v1/event-codemap.json +1089 -0
- package/spec/v1/event-codemap.schema.json +41 -0
- package/spec/v1/extensions.json +1273 -0
- package/spec/v1/gaps.json +14581 -0
- package/spec/v1/gaps.schema.json +55 -0
- package/spec/v1/migrations.json +1822 -0
- package/spec/v1/migrations.schema.json +44 -0
- package/spec/v1/operation-path-manifest.json +462 -0
- package/spec/v1/spec-gaps.json +4823 -0
- package/spec/v2/declaration.json +1862 -0
- package/spec/v2/declaration.schema.json +305 -0
- package/spec/v2/errors.json +837 -0
- package/spec/v2/event-codemap.json +1099 -0
- package/spec/v2/event-codemap.schema.json +114 -0
- package/spec/v2/ext/provider-idempotency/registry.json +6 -0
- package/spec/v2/facets/a2a.schema.json +51 -0
- package/spec/v2/facets/aiProviders.schema.json +56 -0
- package/spec/v2/facets/auth.schema.json +91 -0
- package/spec/v2/facets/heartbeat.schema.json +20 -0
- package/spec/v2/facets/interrupt.schema.json +29 -0
- package/spec/v2/facets/mcp.schema.json +81 -0
- package/spec/v2/facets/replay.schema.json +34 -0
- package/spec/v2/facets/sandbox.schema.json +31 -0
- package/spec/v2/facets/webhooks.schema.json +18 -0
- package/spec/v2/path-manifest.json +279 -0
- package/spec/v2/peer-dependency-aliases.json +165 -0
- package/spec/v2/profiles.json +45 -0
- package/spec/v2/release.json +6 -0
|
@@ -0,0 +1,850 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://openwop.dev/spec/v1/workflow-definition.schema.json",
|
|
4
|
+
"title": "WorkflowDefinition",
|
|
5
|
+
"description": "DAG of typed nodes, edges, triggers, and variables that an OpenWOP host executes. Canonical OpenWOP v1 workflow-definition shape.",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"required": [
|
|
8
|
+
"id",
|
|
9
|
+
"name",
|
|
10
|
+
"version",
|
|
11
|
+
"nodes",
|
|
12
|
+
"edges",
|
|
13
|
+
"triggers",
|
|
14
|
+
"variables",
|
|
15
|
+
"metadata",
|
|
16
|
+
"settings"
|
|
17
|
+
],
|
|
18
|
+
"properties": {
|
|
19
|
+
"id": {
|
|
20
|
+
"type": "string",
|
|
21
|
+
"description": "Unique workflow identifier. Recommended format: lowercase, hyphen-separated.",
|
|
22
|
+
"minLength": 1,
|
|
23
|
+
"maxLength": 128,
|
|
24
|
+
"pattern": "^[a-z][a-z0-9_-]*$"
|
|
25
|
+
},
|
|
26
|
+
"name": {
|
|
27
|
+
"type": "string",
|
|
28
|
+
"minLength": 1,
|
|
29
|
+
"maxLength": 256
|
|
30
|
+
},
|
|
31
|
+
"description": {
|
|
32
|
+
"type": "string"
|
|
33
|
+
},
|
|
34
|
+
"version": {
|
|
35
|
+
"type": "string",
|
|
36
|
+
"description": "Semver-like workflow version. Tracked separately from engineVersion + eventLogSchemaVersion (see version-negotiation.md).",
|
|
37
|
+
"minLength": 1
|
|
38
|
+
},
|
|
39
|
+
"type": {
|
|
40
|
+
"type": "string",
|
|
41
|
+
"description": "Optional category for filtering."
|
|
42
|
+
},
|
|
43
|
+
"isActive": {
|
|
44
|
+
"type": "boolean"
|
|
45
|
+
},
|
|
46
|
+
"status": {
|
|
47
|
+
"type": "string",
|
|
48
|
+
"enum": [
|
|
49
|
+
"active",
|
|
50
|
+
"inactive",
|
|
51
|
+
"draft",
|
|
52
|
+
"archived"
|
|
53
|
+
]
|
|
54
|
+
},
|
|
55
|
+
"tenantId": {
|
|
56
|
+
"type": "string",
|
|
57
|
+
"description": "Optional tenant/workspace scoping. The protocol uses the neutral term `tenantId`."
|
|
58
|
+
},
|
|
59
|
+
"scopeId": {
|
|
60
|
+
"type": "string",
|
|
61
|
+
"description": "Optional project/scope correlation. The protocol uses the neutral term `scopeId`."
|
|
62
|
+
},
|
|
63
|
+
"slug": {
|
|
64
|
+
"type": "string",
|
|
65
|
+
"description": "URL-friendly slug.",
|
|
66
|
+
"pattern": "^[a-z0-9][a-z0-9_-]*$"
|
|
67
|
+
},
|
|
68
|
+
"nodes": {
|
|
69
|
+
"type": "array",
|
|
70
|
+
"items": {
|
|
71
|
+
"$ref": "#/$defs/WorkflowNode"
|
|
72
|
+
},
|
|
73
|
+
"minItems": 1
|
|
74
|
+
},
|
|
75
|
+
"edges": {
|
|
76
|
+
"type": "array",
|
|
77
|
+
"items": {
|
|
78
|
+
"$ref": "#/$defs/WorkflowEdge"
|
|
79
|
+
}
|
|
80
|
+
},
|
|
81
|
+
"triggers": {
|
|
82
|
+
"type": "array",
|
|
83
|
+
"items": {
|
|
84
|
+
"$ref": "#/$defs/WorkflowTrigger"
|
|
85
|
+
}
|
|
86
|
+
},
|
|
87
|
+
"variables": {
|
|
88
|
+
"type": "array",
|
|
89
|
+
"items": {
|
|
90
|
+
"$ref": "#/$defs/WorkflowVariable"
|
|
91
|
+
}
|
|
92
|
+
},
|
|
93
|
+
"groups": {
|
|
94
|
+
"type": "array",
|
|
95
|
+
"items": {
|
|
96
|
+
"$ref": "#/$defs/NodeGroup"
|
|
97
|
+
},
|
|
98
|
+
"description": "Visual node groups (organizational only; do not affect execution)."
|
|
99
|
+
},
|
|
100
|
+
"channels": {
|
|
101
|
+
"description": "Optional typed state channels (see channels-and-reducers.md). When present, channel-aware mode applies.",
|
|
102
|
+
"type": "object",
|
|
103
|
+
"additionalProperties": {
|
|
104
|
+
"$ref": "#/$defs/ChannelDeclaration"
|
|
105
|
+
}
|
|
106
|
+
},
|
|
107
|
+
"configurableSchema": {
|
|
108
|
+
"description": "Optional JSON Schema 2020-12 declaring which RunOptions.configurable keys this workflow accepts. When present, hosts MUST validate POST /v1/runs `configurable` payloads against this schema and reject mismatches with `validation_error`. Hosts MUST surface this schema on GET /v1/workflows/{workflowId} so clients can pre-flight-validate. See run-options.md \u00a7'Per-workflow configurableSchema'. Additive in v1.1.",
|
|
109
|
+
"type": "object"
|
|
110
|
+
},
|
|
111
|
+
"defaults": {
|
|
112
|
+
"type": "object",
|
|
113
|
+
"additionalProperties": false,
|
|
114
|
+
"description": "RFC 0029 \u00a7B. Workflow-author-controlled per-kind fallback values that apply at resolution chain layer 3 (`workflow-defaults`) per `spec/v1/prompts.md` \u00a7\"Resolution chain (normative)\". Applied when neither the node (layer 1) nor the node's bound agent (layer 2) specifies a value for the kind. Future RFCs MAY add sibling defaults (e.g., `defaults.temperature`, `defaults.modelClass`) without colliding.",
|
|
115
|
+
"properties": {
|
|
116
|
+
"promptRefs": {
|
|
117
|
+
"type": "object",
|
|
118
|
+
"additionalProperties": false,
|
|
119
|
+
"description": "Per-kind PromptRef fallbacks for layer 3 of the resolution chain.",
|
|
120
|
+
"properties": {
|
|
121
|
+
"system": {
|
|
122
|
+
"$ref": "./prompt-ref.schema.json"
|
|
123
|
+
},
|
|
124
|
+
"user": {
|
|
125
|
+
"$ref": "./prompt-ref.schema.json"
|
|
126
|
+
},
|
|
127
|
+
"few-shot": {
|
|
128
|
+
"$ref": "./prompt-ref.schema.json"
|
|
129
|
+
},
|
|
130
|
+
"schema-hint": {
|
|
131
|
+
"$ref": "./prompt-ref.schema.json"
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
},
|
|
137
|
+
"metadata": {
|
|
138
|
+
"$ref": "#/$defs/WorkflowMetadata"
|
|
139
|
+
},
|
|
140
|
+
"settings": {
|
|
141
|
+
"$ref": "#/$defs/WorkflowSettings"
|
|
142
|
+
},
|
|
143
|
+
"acceptsInheritedArtifacts": {
|
|
144
|
+
"type": "array",
|
|
145
|
+
"items": {
|
|
146
|
+
"type": "object"
|
|
147
|
+
},
|
|
148
|
+
"description": "Declares which inherited artifacts this workflow accepts when run as a child of a sub-workflow."
|
|
149
|
+
},
|
|
150
|
+
"createdAt": {
|
|
151
|
+
"type": "string",
|
|
152
|
+
"format": "date-time"
|
|
153
|
+
},
|
|
154
|
+
"updatedAt": {
|
|
155
|
+
"type": "string",
|
|
156
|
+
"format": "date-time"
|
|
157
|
+
}
|
|
158
|
+
},
|
|
159
|
+
"additionalProperties": false,
|
|
160
|
+
"$defs": {
|
|
161
|
+
"WorkflowNode": {
|
|
162
|
+
"type": "object",
|
|
163
|
+
"required": [
|
|
164
|
+
"id",
|
|
165
|
+
"typeId",
|
|
166
|
+
"name",
|
|
167
|
+
"position",
|
|
168
|
+
"config",
|
|
169
|
+
"inputs"
|
|
170
|
+
],
|
|
171
|
+
"properties": {
|
|
172
|
+
"id": {
|
|
173
|
+
"type": "string",
|
|
174
|
+
"minLength": 1,
|
|
175
|
+
"description": "Node identifier, unique within the workflow. Intentionally has NO `maxLength` \u2014 RFC 0013 chain expansion mints ids of the form `${chainIdSlug}_${expansionId}_${fragmentId}` where `chainIdSlug` is an unbounded reverse-DNS string, so an expanded node id can exceed any short cap. A host MUST NOT reject or truncate a node id by length (no host-imposed `maxLength` stricter than this schema)."
|
|
176
|
+
},
|
|
177
|
+
"typeId": {
|
|
178
|
+
"type": "string",
|
|
179
|
+
"description": "Canonical node type ID (e.g., 'core.ai.callPrompt', 'core.chat.approvalGate'). Reserved prefixes: 'core.*' for spec-canonical, 'vendor.<org>.*' for third-party.",
|
|
180
|
+
"minLength": 1,
|
|
181
|
+
"pattern": "^[a-z][a-zA-Z0-9._-]*$"
|
|
182
|
+
},
|
|
183
|
+
"name": {
|
|
184
|
+
"type": "string",
|
|
185
|
+
"minLength": 1
|
|
186
|
+
},
|
|
187
|
+
"position": {
|
|
188
|
+
"type": "object",
|
|
189
|
+
"required": [
|
|
190
|
+
"x",
|
|
191
|
+
"y"
|
|
192
|
+
],
|
|
193
|
+
"properties": {
|
|
194
|
+
"x": {
|
|
195
|
+
"type": "number"
|
|
196
|
+
},
|
|
197
|
+
"y": {
|
|
198
|
+
"type": "number"
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
},
|
|
202
|
+
"config": {
|
|
203
|
+
"type": "object",
|
|
204
|
+
"description": "Node configuration (pre-execution constants). The shape is per-typeId \u2014 node-pack manifests declare each typeId's `configSchema` for install-time validation. By convention, the keys `systemPromptRef`, `userPromptRef`, and `additionalPromptRefs` MAY hold PromptRef values per `spec/v1/prompts.md` \u00a7\"PromptRef\" (RFC 0027). Hosts advertising `capabilities.prompts.supported: true` MUST resolve these keys; hosts without the capability MAY treat them as opaque strings. When both an inline body (e.g., `config.systemPrompt`) and a `*PromptRef` are present, the ref wins and the host MUST emit a `log.appended` warning with `code: \"prompt_ref_supersedes_inline\"` per RFC 0027 \u00a7C."
|
|
205
|
+
},
|
|
206
|
+
"inputs": {
|
|
207
|
+
"type": "object",
|
|
208
|
+
"additionalProperties": {
|
|
209
|
+
"$ref": "#/$defs/PortValue"
|
|
210
|
+
},
|
|
211
|
+
"description": "Input port connections. Keys are port names; values are PortValue references."
|
|
212
|
+
},
|
|
213
|
+
"credentialsRef": {
|
|
214
|
+
"type": "string"
|
|
215
|
+
},
|
|
216
|
+
"settings": {
|
|
217
|
+
"type": "object"
|
|
218
|
+
},
|
|
219
|
+
"outputRole": {
|
|
220
|
+
"type": "string",
|
|
221
|
+
"enum": [
|
|
222
|
+
"primary",
|
|
223
|
+
"secondary"
|
|
224
|
+
],
|
|
225
|
+
"description": "RFC 0065 \u2014 author hint that this terminal node's output is the workflow's primary deliverable (`primary`) or an auxiliary output (`secondary`). Advisory: hosts MUST execute the workflow identically regardless of value. Tooling MAY use the hint to pick which of N terminal nodes' outputs to surface as the run's canonical artifact. Unknown values + absent values fall back to default behavior (show all terminal outputs)."
|
|
226
|
+
},
|
|
227
|
+
"disabled": {
|
|
228
|
+
"type": "boolean",
|
|
229
|
+
"default": false
|
|
230
|
+
},
|
|
231
|
+
"notes": {
|
|
232
|
+
"type": "string"
|
|
233
|
+
},
|
|
234
|
+
"groupId": {
|
|
235
|
+
"type": "string"
|
|
236
|
+
},
|
|
237
|
+
"agent": {
|
|
238
|
+
"$ref": "agent-ref.schema.json",
|
|
239
|
+
"description": "Multi-Agent Shift Phase 1. Optional compile-time pinning of which agent executes this node. When set, the engine surfaces this AgentRef on the `RunSnapshot.agent` field while the node is active, and emits an `agent.handoff` event when control transitions from the prior node's agent (if different). Resolution at runtime: the engine MAY override via dispatch (RFC 0012 / `core.dispatch`) or orchestrator decision (RFC 0011); the node's `agent?` is the default authoring-time pin, not a hard binding."
|
|
240
|
+
},
|
|
241
|
+
"envelopeContract": {
|
|
242
|
+
"type": "object"
|
|
243
|
+
},
|
|
244
|
+
"artifactType": {
|
|
245
|
+
"type": "string",
|
|
246
|
+
"description": "Artifact type this node produces or reviews (first-class typed field \u2014 replaces the deprecated config.outputArtifactType bag entry)."
|
|
247
|
+
},
|
|
248
|
+
"cardType": {
|
|
249
|
+
"type": "string",
|
|
250
|
+
"description": "Explicit chat card type override (first-class typed field \u2014 replaces the deprecated config.chatCard bag entry)."
|
|
251
|
+
},
|
|
252
|
+
"outputSensitivity": {
|
|
253
|
+
"type": "object",
|
|
254
|
+
"additionalProperties": {
|
|
255
|
+
"type": "boolean"
|
|
256
|
+
},
|
|
257
|
+
"description": "Per-output-port sensitivity overrides. Map of port name \u2192 boolean. When true, the engine masks the named output value in `node.completed` event payloads. Layered on top of pack-level `nodes[].outputs[port].sensitive` declarations: workflow-level true takes precedence over pack-level false (and vice versa \u2014 last writer wins, but typically pack defaults are conservative and workflow overrides are explicit). See observability.md \u00a7Privacy classification (closes O5)."
|
|
258
|
+
},
|
|
259
|
+
"compensation": {
|
|
260
|
+
"type": "object",
|
|
261
|
+
"description": "RFC 0151 \u00a7B \u2014 the inverse action for this node. OPTIONAL and closed. `nodeTypeId` MUST resolve at registration, so an unwind cannot fail on a typo discovered only during a failure. Inputs MUST derive from RECORDED FACTS: prompt or model regeneration MUST NOT construct a compensation input during replay, because a compensation built from a re-inferred value is not the inverse of what was actually done. A host MUST reject a compensation cycle.",
|
|
262
|
+
"additionalProperties": false,
|
|
263
|
+
"required": [
|
|
264
|
+
"nodeTypeId"
|
|
265
|
+
],
|
|
266
|
+
"properties": {
|
|
267
|
+
"nodeTypeId": {
|
|
268
|
+
"type": "string",
|
|
269
|
+
"minLength": 1,
|
|
270
|
+
"description": "Node type implementing the inverse action. MUST resolve at registration time."
|
|
271
|
+
},
|
|
272
|
+
"inputMapping": {
|
|
273
|
+
"type": "object",
|
|
274
|
+
"description": "Derived from recorded facts only \u2014 node outputs and run inputs already in the event log.",
|
|
275
|
+
"additionalProperties": true
|
|
276
|
+
},
|
|
277
|
+
"retry": {
|
|
278
|
+
"type": "object",
|
|
279
|
+
"additionalProperties": false,
|
|
280
|
+
"properties": {
|
|
281
|
+
"maxAttempts": {
|
|
282
|
+
"type": "integer",
|
|
283
|
+
"minimum": 1
|
|
284
|
+
},
|
|
285
|
+
"backoffMs": {
|
|
286
|
+
"type": "integer",
|
|
287
|
+
"minimum": 0
|
|
288
|
+
}
|
|
289
|
+
}
|
|
290
|
+
},
|
|
291
|
+
"requiresApproval": {
|
|
292
|
+
"type": "boolean",
|
|
293
|
+
"description": "RFC 0151 \u00a7C \u2014 an inverse action can itself be harmful (RFC 0147 R9), so it may be gated behind the same approval surface as a forward effect."
|
|
294
|
+
},
|
|
295
|
+
"waiveRequiresApproval": {
|
|
296
|
+
"type": "boolean",
|
|
297
|
+
"description": "RFC 0151 \u00a7B/\u00a7E (S36, 2026-08-17) \u2014 OPTIONAL. When true, ABANDONING this inverse action (\u00a7E `skip with justification` or `terminate as uncompensated`) requires an RFC 0051 approval to have resolved `approved` first \u2014 if a human must authorize RUNNING an inverse, a human must authorize deciding it will NEVER run. DEFAULT = the obligation's EFFECTIVE `requiresApproval` (after the policy's `approvalScope` escalation, \u00a7B) \u2014 NOT false \u2014 so the field is purely additive: no existing document changes meaning. Stamped onto the obligation at MINT time like `requiresApproval` (a mid-flight redefinition cannot change who had to authorize). Does NOT apply to `substitute` (still an attempt to undo; a substitution is a new planVersion whose own `requiresApproval` governs it). No policy-level counterpart: because the default inherits the effective value, an `approvalScope` escalation escalates waives with it."
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
},
|
|
301
|
+
"irreversibleEffect": {
|
|
302
|
+
"type": "boolean",
|
|
303
|
+
"description": "RFC 0151 \u00a7B (UQ4, resolved 2026-08-16) \u2014 the author states that this node's committed effect HAS NO INVERSE. OPTIONAL; absent or false means nothing (an undeclared compensator is still not implied). Mutually exclusive with `compensation`: a node declaring both is contradictory and a host MUST reject it at registration (`validation_error`). When true and the node's effect committed before an unwind starts, the plan records the node as `irreversible` (never completed) so the \u00a7D rollup caps at `partial` \u2014 a reader can no longer infer a full undo from a `completed` that quietly skipped it."
|
|
304
|
+
}
|
|
305
|
+
},
|
|
306
|
+
"additionalProperties": false,
|
|
307
|
+
"if": {
|
|
308
|
+
"properties": {
|
|
309
|
+
"irreversibleEffect": {
|
|
310
|
+
"const": true
|
|
311
|
+
}
|
|
312
|
+
},
|
|
313
|
+
"required": [
|
|
314
|
+
"irreversibleEffect"
|
|
315
|
+
]
|
|
316
|
+
},
|
|
317
|
+
"then": {
|
|
318
|
+
"not": {
|
|
319
|
+
"required": [
|
|
320
|
+
"compensation"
|
|
321
|
+
]
|
|
322
|
+
}
|
|
323
|
+
}
|
|
324
|
+
},
|
|
325
|
+
"WorkflowEdge": {
|
|
326
|
+
"type": "object",
|
|
327
|
+
"required": [
|
|
328
|
+
"id",
|
|
329
|
+
"sourceNodeId",
|
|
330
|
+
"targetNodeId"
|
|
331
|
+
],
|
|
332
|
+
"properties": {
|
|
333
|
+
"id": {
|
|
334
|
+
"type": "string",
|
|
335
|
+
"minLength": 1
|
|
336
|
+
},
|
|
337
|
+
"sourceNodeId": {
|
|
338
|
+
"type": "string",
|
|
339
|
+
"minLength": 1
|
|
340
|
+
},
|
|
341
|
+
"sourceOutput": {
|
|
342
|
+
"type": "string",
|
|
343
|
+
"description": "Source output port key. Default 'output'."
|
|
344
|
+
},
|
|
345
|
+
"targetNodeId": {
|
|
346
|
+
"type": "string",
|
|
347
|
+
"minLength": 1
|
|
348
|
+
},
|
|
349
|
+
"targetInput": {
|
|
350
|
+
"type": "string",
|
|
351
|
+
"description": "Target input port key. Default 'input'."
|
|
352
|
+
},
|
|
353
|
+
"condition": {
|
|
354
|
+
"$ref": "#/$defs/EdgeCondition"
|
|
355
|
+
},
|
|
356
|
+
"label": {
|
|
357
|
+
"type": "string"
|
|
358
|
+
},
|
|
359
|
+
"triggerRule": {
|
|
360
|
+
"type": "string",
|
|
361
|
+
"enum": [
|
|
362
|
+
"all_success",
|
|
363
|
+
"any_success",
|
|
364
|
+
"all_complete",
|
|
365
|
+
"none_failed",
|
|
366
|
+
"any_failed"
|
|
367
|
+
],
|
|
368
|
+
"default": "all_success"
|
|
369
|
+
}
|
|
370
|
+
},
|
|
371
|
+
"additionalProperties": false
|
|
372
|
+
},
|
|
373
|
+
"EdgeCondition": {
|
|
374
|
+
"type": "object",
|
|
375
|
+
"properties": {
|
|
376
|
+
"type": {
|
|
377
|
+
"type": "string",
|
|
378
|
+
"enum": [
|
|
379
|
+
"expression",
|
|
380
|
+
"equals",
|
|
381
|
+
"notEquals",
|
|
382
|
+
"contains",
|
|
383
|
+
"regex",
|
|
384
|
+
"truthy",
|
|
385
|
+
"falsy"
|
|
386
|
+
],
|
|
387
|
+
"description": "Operator. `equals`/`notEquals`/`contains` compare `left` to `right`; `regex` matches `left` against `right`; `expression` evaluates `expression`. RFC 0134: `truthy`/`falsy` test the resolved value at `left` for JS-style truthiness and take NO `right` operand (the edge contributes iff `left` is truthy \u2014 resp. falsy/absent). `left` is required for all operators except `expression`."
|
|
388
|
+
},
|
|
389
|
+
"left": {
|
|
390
|
+
"type": "string",
|
|
391
|
+
"description": "Left operand path (e.g., 'status', 'output.approved'). Required for every operator except `expression`."
|
|
392
|
+
},
|
|
393
|
+
"right": {
|
|
394
|
+
"description": "Right operand value (any JSON value). Meaningless for `truthy`/`falsy` (RFC 0134) \u2014 a host MUST ignore it there, not error."
|
|
395
|
+
},
|
|
396
|
+
"expression": {
|
|
397
|
+
"type": "string",
|
|
398
|
+
"description": "Used when type='expression'."
|
|
399
|
+
}
|
|
400
|
+
},
|
|
401
|
+
"additionalProperties": false
|
|
402
|
+
},
|
|
403
|
+
"PortValue": {
|
|
404
|
+
"oneOf": [
|
|
405
|
+
{
|
|
406
|
+
"type": "object",
|
|
407
|
+
"required": [
|
|
408
|
+
"type",
|
|
409
|
+
"value"
|
|
410
|
+
],
|
|
411
|
+
"properties": {
|
|
412
|
+
"type": {
|
|
413
|
+
"const": "static"
|
|
414
|
+
},
|
|
415
|
+
"value": {}
|
|
416
|
+
},
|
|
417
|
+
"additionalProperties": false
|
|
418
|
+
},
|
|
419
|
+
{
|
|
420
|
+
"type": "object",
|
|
421
|
+
"required": [
|
|
422
|
+
"type",
|
|
423
|
+
"expression"
|
|
424
|
+
],
|
|
425
|
+
"properties": {
|
|
426
|
+
"type": {
|
|
427
|
+
"const": "expression"
|
|
428
|
+
},
|
|
429
|
+
"expression": {
|
|
430
|
+
"type": "string",
|
|
431
|
+
"minLength": 1
|
|
432
|
+
}
|
|
433
|
+
},
|
|
434
|
+
"additionalProperties": false
|
|
435
|
+
},
|
|
436
|
+
{
|
|
437
|
+
"type": "object",
|
|
438
|
+
"required": [
|
|
439
|
+
"type",
|
|
440
|
+
"nodeId",
|
|
441
|
+
"outputKey"
|
|
442
|
+
],
|
|
443
|
+
"properties": {
|
|
444
|
+
"type": {
|
|
445
|
+
"const": "connection"
|
|
446
|
+
},
|
|
447
|
+
"nodeId": {
|
|
448
|
+
"type": "string",
|
|
449
|
+
"minLength": 1
|
|
450
|
+
},
|
|
451
|
+
"outputKey": {
|
|
452
|
+
"type": "string",
|
|
453
|
+
"minLength": 1
|
|
454
|
+
},
|
|
455
|
+
"optional": {
|
|
456
|
+
"type": "boolean",
|
|
457
|
+
"default": false
|
|
458
|
+
}
|
|
459
|
+
},
|
|
460
|
+
"additionalProperties": false
|
|
461
|
+
},
|
|
462
|
+
{
|
|
463
|
+
"type": "object",
|
|
464
|
+
"required": [
|
|
465
|
+
"type",
|
|
466
|
+
"variableName"
|
|
467
|
+
],
|
|
468
|
+
"properties": {
|
|
469
|
+
"type": {
|
|
470
|
+
"const": "variable"
|
|
471
|
+
},
|
|
472
|
+
"variableName": {
|
|
473
|
+
"type": "string",
|
|
474
|
+
"minLength": 1
|
|
475
|
+
},
|
|
476
|
+
"optional": {
|
|
477
|
+
"type": "boolean",
|
|
478
|
+
"default": false
|
|
479
|
+
}
|
|
480
|
+
},
|
|
481
|
+
"additionalProperties": false
|
|
482
|
+
}
|
|
483
|
+
]
|
|
484
|
+
},
|
|
485
|
+
"WorkflowTrigger": {
|
|
486
|
+
"type": "object",
|
|
487
|
+
"required": [
|
|
488
|
+
"id",
|
|
489
|
+
"type"
|
|
490
|
+
],
|
|
491
|
+
"properties": {
|
|
492
|
+
"id": {
|
|
493
|
+
"type": "string",
|
|
494
|
+
"minLength": 1
|
|
495
|
+
},
|
|
496
|
+
"type": {
|
|
497
|
+
"type": "string",
|
|
498
|
+
"enum": [
|
|
499
|
+
"manual",
|
|
500
|
+
"schedule",
|
|
501
|
+
"webhook",
|
|
502
|
+
"event",
|
|
503
|
+
"artifact",
|
|
504
|
+
"canvas",
|
|
505
|
+
"envelope",
|
|
506
|
+
"command",
|
|
507
|
+
"chat-message",
|
|
508
|
+
"channel-write"
|
|
509
|
+
],
|
|
510
|
+
"description": "Trigger discriminator. The `channel-write` variant fires a node when a named channel receives a write (closes C2 \u2014 reactive cross-engine pattern). Its `config` shape: `{channel: string, onlyFrom?: 'child'|'parent'|'any', debounceMs?: integer}`. See channels-and-reducers.md \u00a7Distributed reducers."
|
|
511
|
+
},
|
|
512
|
+
"name": {
|
|
513
|
+
"type": "string"
|
|
514
|
+
},
|
|
515
|
+
"description": {
|
|
516
|
+
"type": "string"
|
|
517
|
+
},
|
|
518
|
+
"config": {
|
|
519
|
+
"type": "object"
|
|
520
|
+
},
|
|
521
|
+
"enabled": {
|
|
522
|
+
"type": "boolean",
|
|
523
|
+
"default": true
|
|
524
|
+
},
|
|
525
|
+
"nodeId": {
|
|
526
|
+
"type": "string"
|
|
527
|
+
},
|
|
528
|
+
"eventType": {
|
|
529
|
+
"type": "string"
|
|
530
|
+
}
|
|
531
|
+
},
|
|
532
|
+
"additionalProperties": false
|
|
533
|
+
},
|
|
534
|
+
"WorkflowVariable": {
|
|
535
|
+
"type": "object",
|
|
536
|
+
"required": [
|
|
537
|
+
"name",
|
|
538
|
+
"type"
|
|
539
|
+
],
|
|
540
|
+
"properties": {
|
|
541
|
+
"name": {
|
|
542
|
+
"type": "string",
|
|
543
|
+
"minLength": 1
|
|
544
|
+
},
|
|
545
|
+
"type": {
|
|
546
|
+
"type": "string",
|
|
547
|
+
"enum": [
|
|
548
|
+
"string",
|
|
549
|
+
"number",
|
|
550
|
+
"boolean",
|
|
551
|
+
"object",
|
|
552
|
+
"array"
|
|
553
|
+
]
|
|
554
|
+
},
|
|
555
|
+
"description": {
|
|
556
|
+
"type": "string"
|
|
557
|
+
},
|
|
558
|
+
"required": {
|
|
559
|
+
"type": "boolean",
|
|
560
|
+
"default": false
|
|
561
|
+
},
|
|
562
|
+
"defaultValue": {},
|
|
563
|
+
"sensitive": {
|
|
564
|
+
"type": "boolean",
|
|
565
|
+
"default": false,
|
|
566
|
+
"description": "When true, the engine masks this variable's value in persisted `variable.changed` events, `state.snapshot` projections, and `RunSnapshot.variables`. Reads inside NodeModule executors work normally; only persistence + external surfaces mask. See observability.md \u00a7Privacy classification (closes O5)."
|
|
567
|
+
},
|
|
568
|
+
"format": {
|
|
569
|
+
"type": "string",
|
|
570
|
+
"minLength": 1,
|
|
571
|
+
"description": "RFC 0136 (`Active`). ADVISORY presentational hint for a `type: \"string\"` variable, drawn from the JSON-Schema format vocabulary (`email`, `uri`, `date`, `date-time`, `time`, `duration` are the v1 recognised set). Hosts SHOULD use it to choose an input affordance (e.g. an email keyboard). It is NOT a validation contract: a host MUST NOT reject a run, refuse a variable write, or fail validation because a value does not match, and MUST NOT assume a value matches when reading it. DELIBERATELY NOT AN ENUM \u2014 an unrecognised value MUST round-trip and degrade to plain text rather than error (RFC 0136 requirement 2), which an enum would turn into a hard validation failure on a client-submitted (closed) shape. Ignored when `type` is not `\"string\"`. Orthogonal to `sensitive`: masking hides the VALUE on server-emitted surfaces, `format` describes the FIELD in the definition, so the two compose with no interaction."
|
|
572
|
+
}
|
|
573
|
+
},
|
|
574
|
+
"additionalProperties": false
|
|
575
|
+
},
|
|
576
|
+
"NodeGroup": {
|
|
577
|
+
"type": "object",
|
|
578
|
+
"required": [
|
|
579
|
+
"id",
|
|
580
|
+
"name",
|
|
581
|
+
"nodeIds",
|
|
582
|
+
"position",
|
|
583
|
+
"size"
|
|
584
|
+
],
|
|
585
|
+
"properties": {
|
|
586
|
+
"id": {
|
|
587
|
+
"type": "string",
|
|
588
|
+
"minLength": 1
|
|
589
|
+
},
|
|
590
|
+
"name": {
|
|
591
|
+
"type": "string",
|
|
592
|
+
"minLength": 1
|
|
593
|
+
},
|
|
594
|
+
"color": {
|
|
595
|
+
"type": "string"
|
|
596
|
+
},
|
|
597
|
+
"collapsed": {
|
|
598
|
+
"type": "boolean",
|
|
599
|
+
"default": false
|
|
600
|
+
},
|
|
601
|
+
"nodeIds": {
|
|
602
|
+
"type": "array",
|
|
603
|
+
"items": {
|
|
604
|
+
"type": "string"
|
|
605
|
+
}
|
|
606
|
+
},
|
|
607
|
+
"position": {
|
|
608
|
+
"type": "object",
|
|
609
|
+
"required": [
|
|
610
|
+
"x",
|
|
611
|
+
"y"
|
|
612
|
+
],
|
|
613
|
+
"properties": {
|
|
614
|
+
"x": {
|
|
615
|
+
"type": "number"
|
|
616
|
+
},
|
|
617
|
+
"y": {
|
|
618
|
+
"type": "number"
|
|
619
|
+
}
|
|
620
|
+
}
|
|
621
|
+
},
|
|
622
|
+
"size": {
|
|
623
|
+
"type": "object",
|
|
624
|
+
"required": [
|
|
625
|
+
"width",
|
|
626
|
+
"height"
|
|
627
|
+
],
|
|
628
|
+
"properties": {
|
|
629
|
+
"width": {
|
|
630
|
+
"type": "number"
|
|
631
|
+
},
|
|
632
|
+
"height": {
|
|
633
|
+
"type": "number"
|
|
634
|
+
}
|
|
635
|
+
}
|
|
636
|
+
}
|
|
637
|
+
},
|
|
638
|
+
"additionalProperties": false
|
|
639
|
+
},
|
|
640
|
+
"ChannelDeclaration": {
|
|
641
|
+
"type": "object",
|
|
642
|
+
"required": [
|
|
643
|
+
"reducer"
|
|
644
|
+
],
|
|
645
|
+
"properties": {
|
|
646
|
+
"reducer": {
|
|
647
|
+
"type": "string",
|
|
648
|
+
"description": "Canonical names: 'replace', 'append', 'merge', 'counter', 'votes', 'feedback', 'message' (Multi-Agent Shift Phase 1 \u2014 append-only + idempotent on `messageId`). Custom reducers MUST use 'vendor.<org>.<name>'.",
|
|
649
|
+
"pattern": "^(replace|append|merge|counter|votes|feedback|message|vendor\\.[a-z][a-z0-9_-]*\\.[a-z][a-z0-9_-]*)$"
|
|
650
|
+
},
|
|
651
|
+
"schema": {
|
|
652
|
+
"type": "object"
|
|
653
|
+
},
|
|
654
|
+
"default": {},
|
|
655
|
+
"maxSize": {
|
|
656
|
+
"type": "integer",
|
|
657
|
+
"minimum": 1
|
|
658
|
+
},
|
|
659
|
+
"ttlMs": {
|
|
660
|
+
"type": "integer",
|
|
661
|
+
"minimum": 1,
|
|
662
|
+
"maximum": 31536000000,
|
|
663
|
+
"description": "Optional entry-age TTL in milliseconds (closes C3). Applies to `append` / `votes` / `feedback` reducers; ignored on others. Engine drops entries older than this age (lazy: on read or next write). Range: 1..1 year. Replay-safe \u2014 uses original event timestamps for comparison. See channels-and-reducers.md \u00a7Channel TTL."
|
|
664
|
+
},
|
|
665
|
+
"options": {
|
|
666
|
+
"type": "object"
|
|
667
|
+
},
|
|
668
|
+
"access": {
|
|
669
|
+
"$ref": "#/$defs/ChannelAccess"
|
|
670
|
+
},
|
|
671
|
+
"schemaVersion": {
|
|
672
|
+
"type": "integer",
|
|
673
|
+
"minimum": 1,
|
|
674
|
+
"default": 1,
|
|
675
|
+
"description": "Integer version of the current `schema`. Increments whenever the channel author edits `schema`. Each `channel.written` event records this version at write time. (closes C4)"
|
|
676
|
+
},
|
|
677
|
+
"compatibleWith": {
|
|
678
|
+
"type": "array",
|
|
679
|
+
"items": {
|
|
680
|
+
"type": "integer",
|
|
681
|
+
"minimum": 1
|
|
682
|
+
},
|
|
683
|
+
"uniqueItems": true,
|
|
684
|
+
"description": "Older schema versions whose persisted writes are forward-readable under the CURRENT schema. The engine validates each old write against the current schema during fold; pass = include, fail = hard error `channel_schema_breaking_change`. Empty/omitted = no backward compat (any older write trips the breaking-change error). For breaking edits, authors create a new channel name + a copy node \u2014 see channels-and-reducers.md \u00a7Channel schema migration."
|
|
685
|
+
},
|
|
686
|
+
"sensitive": {
|
|
687
|
+
"type": "boolean",
|
|
688
|
+
"default": false,
|
|
689
|
+
"description": "When true, the engine masks `channel.written` event payloads' `value` field. The reduced channel state in `RunSnapshot.channels` is also masked when read via the REST surface. See observability.md \u00a7Privacy classification (closes O5)."
|
|
690
|
+
}
|
|
691
|
+
},
|
|
692
|
+
"additionalProperties": false
|
|
693
|
+
},
|
|
694
|
+
"ChannelAccess": {
|
|
695
|
+
"description": "Per-channel access control. See channels-and-reducers.md \u00a7Channel access control (closes C1). Three forms: 'public' (no restriction; same as omitting), 'private' (lockdown shorthand \u2014 equivalent to {readers: [], writers: []}), or an explicit {readers?, writers?} object where each side is independently scoped (omitted = open, present = strict allowlist).",
|
|
696
|
+
"oneOf": [
|
|
697
|
+
{
|
|
698
|
+
"const": "public"
|
|
699
|
+
},
|
|
700
|
+
{
|
|
701
|
+
"const": "private"
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
"type": "object",
|
|
705
|
+
"properties": {
|
|
706
|
+
"readers": {
|
|
707
|
+
"$ref": "#/$defs/ChannelAccessList"
|
|
708
|
+
},
|
|
709
|
+
"writers": {
|
|
710
|
+
"$ref": "#/$defs/ChannelAccessList"
|
|
711
|
+
}
|
|
712
|
+
},
|
|
713
|
+
"additionalProperties": false
|
|
714
|
+
}
|
|
715
|
+
]
|
|
716
|
+
},
|
|
717
|
+
"ChannelAccessList": {
|
|
718
|
+
"type": "array",
|
|
719
|
+
"description": "Allowlist entries. Each item matches against the requesting node's `nodeId` (exact) OR `typeId` (wildcard). Wildcard format: dotted prefix + '*' (e.g., 'core.ai.*'). Bare '*' matches any node.",
|
|
720
|
+
"items": {
|
|
721
|
+
"type": "string",
|
|
722
|
+
"minLength": 1,
|
|
723
|
+
"maxLength": 256,
|
|
724
|
+
"pattern": "^([a-z][a-zA-Z0-9._-]*\\*?|\\*)$"
|
|
725
|
+
},
|
|
726
|
+
"uniqueItems": true,
|
|
727
|
+
"maxItems": 256
|
|
728
|
+
},
|
|
729
|
+
"WorkflowMetadata": {
|
|
730
|
+
"type": "object",
|
|
731
|
+
"properties": {
|
|
732
|
+
"createdBy": {
|
|
733
|
+
"type": "string"
|
|
734
|
+
},
|
|
735
|
+
"createdAt": {
|
|
736
|
+
"type": "string",
|
|
737
|
+
"format": "date-time"
|
|
738
|
+
},
|
|
739
|
+
"updatedBy": {
|
|
740
|
+
"type": "string"
|
|
741
|
+
},
|
|
742
|
+
"updatedAt": {
|
|
743
|
+
"type": "string",
|
|
744
|
+
"format": "date-time"
|
|
745
|
+
},
|
|
746
|
+
"tags": {
|
|
747
|
+
"type": "array",
|
|
748
|
+
"items": {
|
|
749
|
+
"type": "string",
|
|
750
|
+
"minLength": 1,
|
|
751
|
+
"maxLength": 256
|
|
752
|
+
},
|
|
753
|
+
"maxItems": 100
|
|
754
|
+
},
|
|
755
|
+
"category": {
|
|
756
|
+
"type": "string"
|
|
757
|
+
},
|
|
758
|
+
"author": {
|
|
759
|
+
"type": "string"
|
|
760
|
+
},
|
|
761
|
+
"codeVersion": {
|
|
762
|
+
"type": "string"
|
|
763
|
+
},
|
|
764
|
+
"customizedAt": {
|
|
765
|
+
"type": "string",
|
|
766
|
+
"format": "date-time"
|
|
767
|
+
},
|
|
768
|
+
"customizedBy": {
|
|
769
|
+
"type": "string"
|
|
770
|
+
},
|
|
771
|
+
"forkedFrom": {
|
|
772
|
+
"type": "string",
|
|
773
|
+
"description": "ID of platform template this was forked from."
|
|
774
|
+
},
|
|
775
|
+
"clonedFrom": {
|
|
776
|
+
"type": "string",
|
|
777
|
+
"description": "ID of workflow this was cloned from (project clone, not template fork)."
|
|
778
|
+
},
|
|
779
|
+
"clonedAt": {
|
|
780
|
+
"type": "string",
|
|
781
|
+
"format": "date-time"
|
|
782
|
+
},
|
|
783
|
+
"customProperties": {
|
|
784
|
+
"type": "object"
|
|
785
|
+
},
|
|
786
|
+
"complianceClass": {
|
|
787
|
+
"type": "string",
|
|
788
|
+
"enum": [
|
|
789
|
+
"public",
|
|
790
|
+
"pii",
|
|
791
|
+
"phi",
|
|
792
|
+
"pci",
|
|
793
|
+
"regulated"
|
|
794
|
+
],
|
|
795
|
+
"default": "public",
|
|
796
|
+
"description": "Top-level workflow sensitivity tier. Sets the `openwop.compliance_class` span attribute on every span the run produces. Drives default retention / masking / export-gating policy at observability collectors. See observability.md \u00a7Privacy classification (closes O5)."
|
|
797
|
+
},
|
|
798
|
+
"complianceConfig": {
|
|
799
|
+
"type": "object",
|
|
800
|
+
"description": "Optional per-workflow overrides for compliance behavior. The masking mode (`mask` | `omit` | `hash` | `passthrough`) defaults to the server's `Capabilities.compliance.defaultMode`; setting it here forces a specific mode for this workflow. Domain-specific extensions (HIPAA's 18 PHI identifiers, GDPR special categories) can live here as opt-in fields.",
|
|
801
|
+
"properties": {
|
|
802
|
+
"maskingMode": {
|
|
803
|
+
"type": "string",
|
|
804
|
+
"enum": [
|
|
805
|
+
"mask",
|
|
806
|
+
"omit",
|
|
807
|
+
"hash",
|
|
808
|
+
"passthrough"
|
|
809
|
+
],
|
|
810
|
+
"description": "Per-workflow override of the server's default masking mode."
|
|
811
|
+
}
|
|
812
|
+
},
|
|
813
|
+
"additionalProperties": true
|
|
814
|
+
}
|
|
815
|
+
}
|
|
816
|
+
},
|
|
817
|
+
"WorkflowSettings": {
|
|
818
|
+
"type": "object",
|
|
819
|
+
"properties": {
|
|
820
|
+
"timeout": {
|
|
821
|
+
"type": "integer",
|
|
822
|
+
"minimum": 0,
|
|
823
|
+
"description": "Maximum run duration in milliseconds."
|
|
824
|
+
},
|
|
825
|
+
"maxRetries": {
|
|
826
|
+
"type": "integer",
|
|
827
|
+
"minimum": 0
|
|
828
|
+
},
|
|
829
|
+
"logLevel": {
|
|
830
|
+
"type": "string",
|
|
831
|
+
"enum": [
|
|
832
|
+
"debug",
|
|
833
|
+
"info",
|
|
834
|
+
"warn",
|
|
835
|
+
"error"
|
|
836
|
+
]
|
|
837
|
+
},
|
|
838
|
+
"maxLoopbackIterations": {
|
|
839
|
+
"type": "integer",
|
|
840
|
+
"minimum": 1,
|
|
841
|
+
"default": 5
|
|
842
|
+
},
|
|
843
|
+
"compensation": {
|
|
844
|
+
"$ref": "compensation-policy.schema.json",
|
|
845
|
+
"description": "RFC 0151 \u00a7B \u2014 the workflow-level compensation policy (WHEN an unwind starts and HOW it runs). OPTIONAL and capability-gated: a host that advertises `capabilities.compensation` MUST validate it at registration; a host that does not MUST refuse the workflow with `capability_required` rather than accept a policy it will never honour. Node-level `nodes[].compensation` declarations remain valid without it \u2014 they describe the inverse action; this key requests the unwind."
|
|
846
|
+
}
|
|
847
|
+
}
|
|
848
|
+
}
|
|
849
|
+
}
|
|
850
|
+
}
|