flowspec2 1.0.0__py3-none-any.whl

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.
Files changed (92) hide show
  1. flowspec2/__init__.py +105 -0
  2. flowspec2/authoring/__init__.py +275 -0
  3. flowspec2/authoring/authoring-evidence-signature.schema.json +34 -0
  4. flowspec2/authoring/authoring-evidence.schema.json +455 -0
  5. flowspec2/authoring/authoring-operational-evidence.schema.json +160 -0
  6. flowspec2/authoring/benchmark.py +1409 -0
  7. flowspec2/authoring/corpus/await_correction.case.json +220 -0
  8. flowspec2/authoring/corpus/flowspec2.ctk.json +769 -0
  9. flowspec2/authoring/corpus/gated_derive.case.json +100 -0
  10. flowspec2/authoring/corpus/linear.case.json +55 -0
  11. flowspec2/authoring/corpus/manifest.json +31 -0
  12. flowspec2/authoring/corpus/subflow.case.json +66 -0
  13. flowspec2/authoring/corpus/terminal.case.json +94 -0
  14. flowspec2/authoring/corpus.py +307 -0
  15. flowspec2/authoring/ctk.py +836 -0
  16. flowspec2/authoring/detached_signature.py +120 -0
  17. flowspec2/authoring/evidence.py +311 -0
  18. flowspec2/authoring/evidence_signature.py +187 -0
  19. flowspec2/authoring/evidence_verification.py +229 -0
  20. flowspec2/authoring/gemini.py +215 -0
  21. flowspec2/authoring/operational-corpus.json +61 -0
  22. flowspec2/authoring/operational.py +956 -0
  23. flowspec2/authoring/operational_providers.py +167 -0
  24. flowspec2/authoring/presentation_review.py +1013 -0
  25. flowspec2/authoring/presentation_review_signature.py +305 -0
  26. flowspec2/authoring/projection.py +299 -0
  27. flowspec2/authoring/provider_prompt.py +83 -0
  28. flowspec2/backends/__init__.py +82 -0
  29. flowspec2/backends/http.py +189 -0
  30. flowspec2/checker.py +238 -0
  31. flowspec2/cli.py +789 -0
  32. flowspec2/cli_parser.py +345 -0
  33. flowspec2/clock.py +23 -0
  34. flowspec2/compat/__init__.py +47 -0
  35. flowspec2/compat/models.py +82 -0
  36. flowspec2/compat/open_workflow.py +616 -0
  37. flowspec2/compat/rasa.py +19 -0
  38. flowspec2/compat/rasa_export.py +876 -0
  39. flowspec2/compat/rasa_import.py +992 -0
  40. flowspec2/compat/rasa_shared.py +270 -0
  41. flowspec2/compat/schemas/open-workflow-conversation-1.schema.json +138 -0
  42. flowspec2/compat/schemas/vendor/open-workflow-1.0.3.LICENSE +201 -0
  43. flowspec2/compat/schemas/vendor/open-workflow-1.0.3.provenance.json +13 -0
  44. flowspec2/compat/schemas/vendor/open-workflow-1.0.3.workflow.yaml +1956 -0
  45. flowspec2/compat/tool_profiles.py +149 -0
  46. flowspec2/compat/yaml.py +147 -0
  47. flowspec2/compiler.py +957 -0
  48. flowspec2/compiler_contracts.py +17 -0
  49. flowspec2/compiler_resume_contracts.py +594 -0
  50. flowspec2/compiler_schema_relations.py +1830 -0
  51. flowspec2/compiler_tool_contracts.py +245 -0
  52. flowspec2/compiler_value_contracts.py +447 -0
  53. flowspec2/derive.py +32 -0
  54. flowspec2/diagnostics.py +94 -0
  55. flowspec2/domains.py +489 -0
  56. flowspec2/experimental/__init__.py +57 -0
  57. flowspec2/experimental/flowspec-3-draft.schema.json +923 -0
  58. flowspec2/experimental/v3-preview-loss-policy.json +161 -0
  59. flowspec2/experimental/v3_lowering.py +928 -0
  60. flowspec2/experimental/v3_preview.py +2460 -0
  61. flowspec2/flowspec-2.schema.json +635 -0
  62. flowspec2/interactive.py +300 -0
  63. flowspec2/ir.py +1459 -0
  64. flowspec2/json_codec.py +120 -0
  65. flowspec2/llm.py +366 -0
  66. flowspec2/models.py +121 -0
  67. flowspec2/nodes.py +1537 -0
  68. flowspec2/observability.py +151 -0
  69. flowspec2/predicates.py +89 -0
  70. flowspec2/profiles.py +118 -0
  71. flowspec2/py.typed +0 -0
  72. flowspec2/runtime.py +1059 -0
  73. flowspec2/schema.py +54 -0
  74. flowspec2/schema_contracts.py +203 -0
  75. flowspec2/semantic_derive_contracts.py +530 -0
  76. flowspec2/semantic_path_contracts.py +528 -0
  77. flowspec2/semantic_predicate_contracts.py +355 -0
  78. flowspec2/semantic_schema_contracts.py +137 -0
  79. flowspec2/semantic_source_contracts.py +21 -0
  80. flowspec2/semantic_state_contracts.py +450 -0
  81. flowspec2/semantic_support.py +40 -0
  82. flowspec2/semantics.py +410 -0
  83. flowspec2/state_migration.py +1034 -0
  84. flowspec2/subflows/__init__.py +1117 -0
  85. flowspec2/subflows/address.py +328 -0
  86. flowspec2/subflows/identification.py +1031 -0
  87. flowspec2/tools.py +1154 -0
  88. flowspec2-1.0.0.dist-info/METADATA +482 -0
  89. flowspec2-1.0.0.dist-info/RECORD +92 -0
  90. flowspec2-1.0.0.dist-info/WHEEL +4 -0
  91. flowspec2-1.0.0.dist-info/entry_points.txt +2 -0
  92. flowspec2-1.0.0.dist-info/licenses/LICENSE +21 -0
@@ -0,0 +1,1956 @@
1
+ $id: https://serverlessworkflow.io/schemas/1.0.3/workflow.yaml
2
+ $schema: https://json-schema.org/draft/2020-12/schema
3
+ description: Serverless Workflow DSL - Workflow Schema.
4
+ type: object
5
+ required: [ document, do ]
6
+ properties:
7
+ document:
8
+ type: object
9
+ title: Document
10
+ description: Documents the workflow.
11
+ unevaluatedProperties: false
12
+ properties:
13
+ dsl:
14
+ type: string
15
+ pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
16
+ title: WorkflowDSL
17
+ description: The version of the DSL used by the workflow.
18
+ namespace:
19
+ type: string
20
+ pattern: ^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$
21
+ title: WorkflowNamespace
22
+ description: The workflow's namespace.
23
+ name:
24
+ type: string
25
+ pattern: ^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$
26
+ title: WorkflowName
27
+ description: The workflow's name.
28
+ version:
29
+ type: string
30
+ pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
31
+ title: WorkflowVersion
32
+ description: The workflow's semantic version.
33
+ title:
34
+ type: string
35
+ title: WorkflowTitle
36
+ description: The workflow's title.
37
+ summary:
38
+ type: string
39
+ title: WorkflowSummary
40
+ description: The workflow's Markdown summary.
41
+ tags:
42
+ type: object
43
+ title: WorkflowTags
44
+ description: A key/value mapping of the workflow's tags, if any.
45
+ additionalProperties: true
46
+ metadata:
47
+ type: object
48
+ title: WorkflowMetadata
49
+ description: Holds additional information about the workflow.
50
+ additionalProperties: true
51
+ required: [ dsl, namespace, name, version ]
52
+ input:
53
+ $ref: '#/$defs/input'
54
+ title: Input
55
+ description: Configures the workflow's input.
56
+ use:
57
+ type: object
58
+ title: Use
59
+ description: Defines the workflow's reusable components.
60
+ unevaluatedProperties: false
61
+ properties:
62
+ authentications:
63
+ type: object
64
+ title: UseAuthentications
65
+ description: The workflow's reusable authentication policies.
66
+ additionalProperties:
67
+ $ref: '#/$defs/authenticationPolicy'
68
+ errors:
69
+ type: object
70
+ title: UseErrors
71
+ description: The workflow's reusable errors.
72
+ additionalProperties:
73
+ $ref: '#/$defs/error'
74
+ extensions:
75
+ type: array
76
+ title: UseExtensions
77
+ description: The workflow's extensions.
78
+ items:
79
+ type: object
80
+ title: ExtensionItem
81
+ minProperties: 1
82
+ maxProperties: 1
83
+ additionalProperties:
84
+ $ref: '#/$defs/extension'
85
+ functions:
86
+ type: object
87
+ title: UseFunctions
88
+ description: The workflow's reusable functions.
89
+ additionalProperties:
90
+ $ref: '#/$defs/task'
91
+ retries:
92
+ type: object
93
+ title: UseRetries
94
+ description: The workflow's reusable retry policies.
95
+ additionalProperties:
96
+ $ref: '#/$defs/retryPolicy'
97
+ secrets:
98
+ type: array
99
+ title: UseSecrets
100
+ description: The workflow's reusable secrets.
101
+ items:
102
+ type: string
103
+ description: The workflow's secrets.
104
+ timeouts:
105
+ type: object
106
+ title: UseTimeouts
107
+ description: The workflow's reusable timeouts.
108
+ additionalProperties:
109
+ $ref: '#/$defs/timeout'
110
+ catalogs:
111
+ type: object
112
+ title: UseCatalogs
113
+ description: The workflow's reusable catalogs.
114
+ additionalProperties:
115
+ $ref: '#/$defs/catalog'
116
+ do:
117
+ $ref: '#/$defs/taskList'
118
+ title: Do
119
+ description: Defines the task(s) the workflow must perform.
120
+ timeout:
121
+ title: DoTimeout
122
+ oneOf:
123
+ - $ref: '#/$defs/timeout'
124
+ title: TimeoutDefinition
125
+ description: The workflow's timeout configuration, if any.
126
+ - type: string
127
+ title: TimeoutReference
128
+ description: The name of the workflow's timeout, if any.
129
+ output:
130
+ $ref: '#/$defs/output'
131
+ title: Output
132
+ description: Configures the workflow's output.
133
+ schedule:
134
+ type: object
135
+ title: Schedule
136
+ description: Schedules the workflow.
137
+ unevaluatedProperties: false
138
+ properties:
139
+ every:
140
+ $ref: '#/$defs/duration'
141
+ title: ScheduleEvery
142
+ description: Specifies the duration of the interval at which the workflow should be executed.
143
+ cron:
144
+ type: string
145
+ title: ScheduleCron
146
+ description: Specifies the schedule using a cron expression, e.g., '0 0 * * *' for daily at midnight.
147
+ after:
148
+ $ref: '#/$defs/duration'
149
+ title: ScheduleAfter
150
+ description: Specifies a delay duration that the workflow must wait before starting again after it completes.
151
+ on:
152
+ $ref: '#/$defs/eventConsumptionStrategy'
153
+ title: ScheduleOn
154
+ description: Specifies the events that trigger the workflow execution.
155
+ $defs:
156
+ taskList:
157
+ title: TaskList
158
+ description: List of named tasks to perform.
159
+ type: array
160
+ items:
161
+ type: object
162
+ title: TaskItem
163
+ minProperties: 1
164
+ maxProperties: 1
165
+ additionalProperties:
166
+ $ref: '#/$defs/task'
167
+ taskBase:
168
+ type: object
169
+ title: TaskBase
170
+ description: An object inherited by all tasks.
171
+ properties:
172
+ if:
173
+ type: string
174
+ title: TaskBaseIf
175
+ description: A runtime expression, if any, used to determine whether or not the task should be run.
176
+ input:
177
+ $ref: '#/$defs/input'
178
+ title: TaskBaseInput
179
+ description: Configure the task's input.
180
+ output:
181
+ $ref: '#/$defs/output'
182
+ title: TaskBaseOutput
183
+ description: Configure the task's output.
184
+ export:
185
+ $ref: '#/$defs/export'
186
+ title: TaskBaseExport
187
+ description: Export task output to context.
188
+ timeout:
189
+ title: TaskTimeout
190
+ oneOf:
191
+ - $ref: '#/$defs/timeout'
192
+ title: TaskTimeoutDefinition
193
+ description: The task's timeout configuration, if any.
194
+ - type: string
195
+ title: TaskTimeoutReference
196
+ description: The name of the task's timeout, if any.
197
+ then:
198
+ $ref: '#/$defs/flowDirective'
199
+ title: TaskBaseThen
200
+ description: The flow directive to be performed upon completion of the task.
201
+ metadata:
202
+ type: object
203
+ title: TaskMetadata
204
+ description: Holds additional information about the task.
205
+ additionalProperties: true
206
+ task:
207
+ title: Task
208
+ description: A discrete unit of work that contributes to achieving the overall objectives defined by the workflow.
209
+ unevaluatedProperties: false
210
+ oneOf:
211
+ - $ref: '#/$defs/callTask'
212
+ - $ref: '#/$defs/doTask'
213
+ - $ref: '#/$defs/forkTask'
214
+ - $ref: '#/$defs/emitTask'
215
+ - $ref: '#/$defs/forTask'
216
+ - $ref: '#/$defs/listenTask'
217
+ - $ref: '#/$defs/raiseTask'
218
+ - $ref: '#/$defs/runTask'
219
+ - $ref: '#/$defs/setTask'
220
+ - $ref: '#/$defs/switchTask'
221
+ - $ref: '#/$defs/tryTask'
222
+ - $ref: '#/$defs/waitTask'
223
+ callTask:
224
+ title: CallTask
225
+ description: Defines the call to perform.
226
+ oneOf:
227
+ - title: CallAsyncAPI
228
+ description: Defines the AsyncAPI call to perform.
229
+ type: object
230
+ required: [ call, with ]
231
+ unevaluatedProperties: false
232
+ allOf:
233
+ - $ref: '#/$defs/taskBase'
234
+ - properties:
235
+ call:
236
+ type: string
237
+ const: asyncapi
238
+ with:
239
+ type: object
240
+ title: AsyncApiArguments
241
+ description: The Async API call arguments.
242
+ properties:
243
+ document:
244
+ $ref: '#/$defs/externalResource'
245
+ title: AsyncAPIDocument
246
+ description: The document that defines the AsyncAPI operation to call.
247
+ channel:
248
+ type: string
249
+ title: With
250
+ description: The name of the channel on which to perform the operation. Used only in case the referenced document uses AsyncAPI v2.6.0.
251
+ operation:
252
+ type: string
253
+ title: AsyncAPIOperation
254
+ description: A reference to the AsyncAPI operation to call.
255
+ server:
256
+ $ref: '#/$defs/asyncApiServer'
257
+ title: AsyncAPIServer
258
+ description: An object used to configure to the server to call the specified AsyncAPI operation on.
259
+ protocol:
260
+ type: string
261
+ title: AsyncApiProtocol
262
+ description: The protocol to use to select the target server.
263
+ enum: [ amqp, amqp1, anypointmq, googlepubsub, http, ibmmq, jms, kafka, mercure, mqtt, mqtt5, nats, pulsar, redis, sns, solace, sqs, stomp, ws ]
264
+ message:
265
+ $ref: '#/$defs/asyncApiOutboundMessage'
266
+ title: AsyncApiMessage
267
+ description: An object used to configure the message to publish using the target operation.
268
+ subscription:
269
+ $ref: '#/$defs/asyncApiSubscription'
270
+ title: AsyncApiSubscription
271
+ description: An object used to configure the subscription to messages consumed using the target operation.
272
+ authentication:
273
+ $ref: '#/$defs/referenceableAuthenticationPolicy'
274
+ title: AsyncAPIAuthentication
275
+ description: The authentication policy, if any, to use when calling the AsyncAPI operation.
276
+ oneOf:
277
+ - required: [ document, operation, message ]
278
+ - required: [ document, operation, subscription ]
279
+ - required: [ document, channel, message ]
280
+ - required: [ document, channel, subscription ]
281
+ unevaluatedProperties: false
282
+ - title: CallGRPC
283
+ description: Defines the GRPC call to perform.
284
+ type: object
285
+ unevaluatedProperties: false
286
+ required: [ call, with ]
287
+ allOf:
288
+ - $ref: '#/$defs/taskBase'
289
+ - properties:
290
+ call:
291
+ type: string
292
+ const: grpc
293
+ with:
294
+ type: object
295
+ title: GRPCArguments
296
+ description: The GRPC call arguments.
297
+ properties:
298
+ proto:
299
+ $ref: '#/$defs/externalResource'
300
+ title: WithGRPCProto
301
+ description: The proto resource that describes the GRPC service to call.
302
+ service:
303
+ type: object
304
+ title: WithGRPCService
305
+ unevaluatedProperties: false
306
+ properties:
307
+ name:
308
+ type: string
309
+ title: WithGRPCServiceName
310
+ description: The name of the GRPC service to call.
311
+ host:
312
+ type: string
313
+ title: WithGRPCServiceHost
314
+ description: The hostname of the GRPC service to call.
315
+ pattern: ^[a-zA-Z0-9](?:[a-zA-Z0-9-.]{0,61}[a-zA-Z0-9])?$
316
+ port:
317
+ type: integer
318
+ title: WithGRPCServicePort
319
+ description: The port number of the GRPC service to call.
320
+ minimum: 0
321
+ maximum: 65535
322
+ authentication:
323
+ $ref: '#/$defs/referenceableAuthenticationPolicy'
324
+ title: WithGRPCServiceAuthentication
325
+ description: The endpoint's authentication policy, if any.
326
+ required: [ name, host ]
327
+ method:
328
+ type: string
329
+ title: WithGRPCMethod
330
+ description: The name of the method to call on the defined GRPC service.
331
+ arguments:
332
+ type: object
333
+ title: WithGRPCArguments
334
+ description: The arguments, if any, to call the method with.
335
+ additionalProperties: true
336
+ required: [ proto, service, method ]
337
+ unevaluatedProperties: false
338
+ - title: CallHTTP
339
+ description: Defines the HTTP call to perform.
340
+ type: object
341
+ unevaluatedProperties: false
342
+ required: [ call, with ]
343
+ allOf:
344
+ - $ref: '#/$defs/taskBase'
345
+ - properties:
346
+ call:
347
+ type: string
348
+ const: http
349
+ with:
350
+ type: object
351
+ title: HTTPArguments
352
+ description: The HTTP call arguments.
353
+ properties:
354
+ method:
355
+ type: string
356
+ title: HTTPMethod
357
+ description: The HTTP method of the HTTP request to perform.
358
+ endpoint:
359
+ title: HTTPEndpoint
360
+ description: The HTTP endpoint to send the request to.
361
+ $ref: '#/$defs/endpoint'
362
+ headers:
363
+ oneOf:
364
+ - type: object
365
+ additionalProperties:
366
+ type: string
367
+ - $ref: '#/$defs/runtimeExpression'
368
+ title: HTTPHeaders
369
+ description: A name/value mapping of the headers, if any, of the HTTP request to perform.
370
+ body:
371
+ title: HTTPBody
372
+ description: The body, if any, of the HTTP request to perform.
373
+ query:
374
+ oneOf:
375
+ - type: object
376
+ additionalProperties:
377
+ type: string
378
+ - $ref: '#/$defs/runtimeExpression'
379
+ title: HTTPQuery
380
+ description: A name/value mapping of the query parameters, if any, of the HTTP request to perform.
381
+ additionalProperties: true
382
+ output:
383
+ type: string
384
+ title: HTTPOutput
385
+ description: The http call output format. Defaults to 'content'.
386
+ enum: [ raw, content, response ]
387
+ redirect:
388
+ type: boolean
389
+ title: HttpRedirect
390
+ description: Specifies whether redirection status codes (`300–399`) should be treated as errors.
391
+ required: [ method, endpoint ]
392
+ unevaluatedProperties: false
393
+ - title: CallOpenAPI
394
+ description: Defines the OpenAPI call to perform.
395
+ type: object
396
+ unevaluatedProperties: false
397
+ required: [ call, with ]
398
+ allOf:
399
+ - $ref: '#/$defs/taskBase'
400
+ - properties:
401
+ call:
402
+ type: string
403
+ const: openapi
404
+ with:
405
+ type: object
406
+ title: OpenAPIArguments
407
+ description: The OpenAPI call arguments.
408
+ properties:
409
+ document:
410
+ $ref: '#/$defs/externalResource'
411
+ title: WithOpenAPIDocument
412
+ description: The document that defines the OpenAPI operation to call.
413
+ operationId:
414
+ type: string
415
+ title: WithOpenAPIOperation
416
+ description: The id of the OpenAPI operation to call.
417
+ parameters:
418
+ type: object
419
+ title: WithOpenAPIParameters
420
+ description: A name/value mapping of the parameters of the OpenAPI operation to call.
421
+ additionalProperties: true
422
+ authentication:
423
+ $ref: '#/$defs/referenceableAuthenticationPolicy'
424
+ title: WithOpenAPIAuthentication
425
+ description: The authentication policy, if any, to use when calling the OpenAPI operation.
426
+ output:
427
+ type: string
428
+ enum: [ raw, content, response ]
429
+ title: WithOpenAPIOutput
430
+ description: The http call output format. Defaults to 'content'.
431
+ redirect:
432
+ type: boolean
433
+ title: HttpRedirect
434
+ description: Specifies whether redirection status codes (`300–399`) should be treated as errors.
435
+ required: [ document, operationId ]
436
+ unevaluatedProperties: false
437
+ - title: CallA2A
438
+ description: Defines the A2A call to perform.
439
+ type: object
440
+ unevaluatedProperties: false
441
+ required: [ call, with ]
442
+ allOf:
443
+ - $ref: '#/$defs/taskBase'
444
+ - properties:
445
+ call:
446
+ type: string
447
+ const: a2a
448
+ with:
449
+ type: object
450
+ title: A2AArguments
451
+ description: The A2A call arguments.
452
+ properties:
453
+ agentCard:
454
+ $ref: '#/$defs/externalResource'
455
+ title: WithA2AAgentCard
456
+ description: The Agent Card that defines the agent to call.
457
+ server:
458
+ title: A2AServer
459
+ description: The server endpoint to send the request to.
460
+ $ref: '#/$defs/endpoint'
461
+ method:
462
+ type: string
463
+ title: WithA2AMethod
464
+ description: The A2A method to send.
465
+ enum: [ 'message/send', 'message/stream', 'tasks/get', 'tasks/list', 'tasks/cancel', 'tasks/resubscribe', 'tasks/pushNotificationConfig/set', 'tasks/pushNotificationConfig/get', 'tasks/pushNotificationConfig/list', 'tasks/pushNotificationConfig/delete', 'agent/getAuthenticatedExtendedCard' ]
466
+ parameters:
467
+ oneOf:
468
+ - type: object
469
+ minProperties: 1
470
+ additionalProperties: true
471
+ - type: string
472
+ title: WithA2AParameters
473
+ description: The parameters object to send with the A2A method.
474
+ required: [ method ]
475
+ unevaluatedProperties: false
476
+ - title: CallMCP
477
+ description: Defines the MCP call to perform.
478
+ type: object
479
+ unevaluatedProperties: false
480
+ required: [ call, with ]
481
+ allOf:
482
+ - $ref: '#/$defs/taskBase'
483
+ - properties:
484
+ call:
485
+ type: string
486
+ const: mcp
487
+ with:
488
+ type: object
489
+ title: MCPArguments
490
+ description: The MCP call arguments.
491
+ properties:
492
+ protocolVersion:
493
+ type: string
494
+ default: '2025-06-18'
495
+ title: McpProtocolVersion
496
+ description: The version of the MCP protocol to use.
497
+ method:
498
+ type: string
499
+ enum: [ tools/list, tools/call, prompts/list, prompts/get, resources/list, resources/read, resources/templates/list ]
500
+ title: McpMethod
501
+ description: The MCP method to call.
502
+ parameters:
503
+ oneOf:
504
+ - type: object
505
+ additionalProperties: true
506
+ - type: string
507
+ title: McpMethodParameters
508
+ description: The MCP method parameters.
509
+ timeout:
510
+ $ref: '#/$defs/duration'
511
+ title: McpCallTimeout
512
+ description: The duration after which the MCP call times out.
513
+ transport:
514
+ type: object
515
+ title: McpCallTransport
516
+ description: The transport to use to perform the MCP call.
517
+ properties:
518
+ http:
519
+ type: object
520
+ title: McpHttpTransport
521
+ description: The definition of the HTTP transport to use.
522
+ properties:
523
+ endpoint:
524
+ $ref: '#/$defs/endpoint'
525
+ title: McpHttpTransportEndpoint
526
+ description: The MCP server endpoint to connect to.
527
+ headers:
528
+ type: object
529
+ additionalProperties:
530
+ type: string
531
+ title: McpHttpTransportHeaders
532
+ description: A key/value mapping of the HTTP headers to send with requests, if any.
533
+ required: [ endpoint ]
534
+ stdio:
535
+ type: object
536
+ title: McpStdioTransport
537
+ description: The definition of the STDIO transport to use.
538
+ properties:
539
+ command:
540
+ type: string
541
+ title: McpStdioTransportCommand
542
+ description: The command used to run the MCP server.
543
+ arguments:
544
+ type: array
545
+ items:
546
+ type: string
547
+ title: McpStdioTransportArguments
548
+ description: An optional list of arguments to pass to the command.
549
+ environment:
550
+ type: object
551
+ additionalProperties:
552
+ type: string
553
+ title: McpStdioTransportEnvironment
554
+ description: A key/value mapping, if any, of environment variables used to configure the MCP server.
555
+ required: [ command ]
556
+ options:
557
+ type: object
558
+ additionalProperties:
559
+ type: string
560
+ oneOf:
561
+ - required: [http]
562
+ - required: [stdio]
563
+ client:
564
+ type: object
565
+ title: McpClient
566
+ description: Describes the client used to perform the MCP call.
567
+ properties:
568
+ name:
569
+ type: string
570
+ title: McpClientName
571
+ description: The name of the client used to connect to the MCP server.
572
+ description:
573
+ type: string
574
+ title: McpClientVersion
575
+ description: The version of the client used to connect to the MCP server.
576
+ required: [ name, version ]
577
+ required: [ method, transport ]
578
+ - title: CallFunction
579
+ description: Defines the function call to perform.
580
+ type: object
581
+ unevaluatedProperties: false
582
+ required: [ call ]
583
+ allOf:
584
+ - $ref: '#/$defs/taskBase'
585
+ - properties:
586
+ call:
587
+ type: string
588
+ not:
589
+ enum: ["asyncapi", "grpc", "http", "openapi", "a2a", "mcp"]
590
+ description: The name of the function to call.
591
+ with:
592
+ type: object
593
+ title: FunctionArguments
594
+ description: A name/value mapping of the parameters, if any, to call the function with.
595
+ additionalProperties: true
596
+ forkTask:
597
+ type: object
598
+ title: ForkTask
599
+ description: Allows workflows to execute multiple tasks concurrently and optionally race them against each other, with a single possible winner, which sets the task's output.
600
+ unevaluatedProperties: false
601
+ required: [ fork ]
602
+ allOf:
603
+ - $ref: '#/$defs/taskBase'
604
+ - properties:
605
+ fork:
606
+ type: object
607
+ title: ForkTaskConfiguration
608
+ description: The configuration of the branches to perform concurrently.
609
+ unevaluatedProperties: false
610
+ required: [ branches ]
611
+ properties:
612
+ branches:
613
+ $ref: '#/$defs/taskList'
614
+ title: ForkBranches
615
+ compete:
616
+ type: boolean
617
+ title: ForkCompete
618
+ description: Indicates whether or not the concurrent tasks are racing against each other, with a single possible winner, which sets the composite task's output.
619
+ default: false
620
+ doTask:
621
+ type: object
622
+ title: DoTask
623
+ description: Allows to execute a list of tasks in sequence.
624
+ unevaluatedProperties: false
625
+ required: [ do ]
626
+ allOf:
627
+ - $ref: '#/$defs/taskBase'
628
+ - properties:
629
+ do:
630
+ $ref: '#/$defs/taskList'
631
+ title: DoTaskConfiguration
632
+ description: The configuration of the tasks to perform sequentially.
633
+ emitTask:
634
+ type: object
635
+ title: EmitTask
636
+ description: Allows workflows to publish events to event brokers or messaging systems, facilitating communication and coordination between different components and services.
637
+ required: [ emit ]
638
+ unevaluatedProperties: false
639
+ allOf:
640
+ - $ref: '#/$defs/taskBase'
641
+ - properties:
642
+ emit:
643
+ type: object
644
+ title: EmitTaskConfiguration
645
+ description: The configuration of an event's emission.
646
+ unevaluatedProperties: false
647
+ properties:
648
+ event:
649
+ type: object
650
+ title: EmitEventDefinition
651
+ description: The definition of the event to emit.
652
+ properties:
653
+ with:
654
+ $ref: '#/$defs/eventProperties'
655
+ title: EmitEventWith
656
+ description: Defines the properties of event to emit.
657
+ required: [ source, type ]
658
+ additionalProperties: true
659
+ required: [ event ]
660
+ forTask:
661
+ type: object
662
+ title: ForTask
663
+ description: Allows workflows to iterate over a collection of items, executing a defined set of subtasks for each item in the collection. This task type is instrumental in handling scenarios such as batch processing, data transformation, and repetitive operations across datasets.
664
+ required: [ for, do ]
665
+ unevaluatedProperties: false
666
+ allOf:
667
+ - $ref: '#/$defs/taskBase'
668
+ - properties:
669
+ for:
670
+ type: object
671
+ title: ForTaskConfiguration
672
+ description: The definition of the loop that iterates over a range of values.
673
+ unevaluatedProperties: false
674
+ properties:
675
+ each:
676
+ type: string
677
+ title: ForEach
678
+ description: The name of the variable used to store the current item being enumerated.
679
+ default: item
680
+ in:
681
+ type: string
682
+ title: ForIn
683
+ description: A runtime expression used to get the collection to enumerate.
684
+ at:
685
+ type: string
686
+ title: ForAt
687
+ description: The name of the variable used to store the index of the current item being enumerated.
688
+ default: index
689
+ required: [ in ]
690
+ while:
691
+ type: string
692
+ title: While
693
+ description: A runtime expression that represents the condition, if any, that must be met for the iteration to continue.
694
+ do:
695
+ $ref: '#/$defs/taskList'
696
+ title: ForTaskDo
697
+ listenTask:
698
+ type: object
699
+ title: ListenTask
700
+ description: Provides a mechanism for workflows to await and react to external events, enabling event-driven behavior within workflow systems.
701
+ required: [ listen ]
702
+ unevaluatedProperties: false
703
+ allOf:
704
+ - $ref: '#/$defs/taskBase'
705
+ - properties:
706
+ listen:
707
+ type: object
708
+ title: ListenTaskConfiguration
709
+ description: The configuration of the listener to use.
710
+ unevaluatedProperties: false
711
+ properties:
712
+ to:
713
+ $ref: '#/$defs/eventConsumptionStrategy'
714
+ title: ListenTo
715
+ description: Defines the event(s) to listen to.
716
+ read:
717
+ type: string
718
+ enum: [ data, envelope, raw ]
719
+ default: data
720
+ title: ListenAndReadAs
721
+ description: Specifies how events are read during the listen operation.
722
+ required: [ to ]
723
+ foreach:
724
+ $ref: '#/$defs/subscriptionIterator'
725
+ title: ListenIterator
726
+ description: Configures the iterator, if any, for processing consumed event(s).
727
+ raiseTask:
728
+ type: object
729
+ title: RaiseTask
730
+ description: Intentionally triggers and propagates errors.
731
+ required: [ raise ]
732
+ unevaluatedProperties: false
733
+ allOf:
734
+ - $ref: '#/$defs/taskBase'
735
+ - properties:
736
+ raise:
737
+ type: object
738
+ title: RaiseTaskConfiguration
739
+ description: The definition of the error to raise.
740
+ unevaluatedProperties: false
741
+ properties:
742
+ error:
743
+ title: RaiseTaskError
744
+ oneOf:
745
+ - $ref: '#/$defs/error'
746
+ title: RaiseErrorDefinition
747
+ description: Defines the error to raise.
748
+ - type: string
749
+ title: RaiseErrorReference
750
+ description: The name of the error to raise
751
+ required: [ error ]
752
+ runTask:
753
+ type: object
754
+ title: RunTask
755
+ description: Provides the capability to execute external containers, shell commands, scripts, or workflows.
756
+ required: [ run ]
757
+ unevaluatedProperties: false
758
+ allOf:
759
+ - $ref: '#/$defs/taskBase'
760
+ - properties:
761
+ run:
762
+ type: object
763
+ title: RunTaskConfiguration
764
+ description: The configuration of the process to execute.
765
+ unevaluatedProperties: false
766
+ properties:
767
+ await:
768
+ type: boolean
769
+ default: true
770
+ title: AwaitProcessCompletion
771
+ description: Whether to await the process completion before continuing.
772
+ return:
773
+ type: string
774
+ title: ProcessReturnType
775
+ description: Configures the output of the process.
776
+ enum: [ stdout, stderr, code, all, none ]
777
+ default: stdout
778
+ oneOf:
779
+ - title: RunContainer
780
+ description: Enables the execution of external processes encapsulated within a containerized environment.
781
+ properties:
782
+ container:
783
+ type: object
784
+ title: Container
785
+ description: The configuration of the container to run.
786
+ unevaluatedProperties: false
787
+ properties:
788
+ image:
789
+ type: string
790
+ title: ContainerImage
791
+ description: The name of the container image to run.
792
+ name:
793
+ type: string
794
+ title: ContainerName
795
+ description: A runtime expression, if any, used to give specific name to the container.
796
+ command:
797
+ type: string
798
+ title: ContainerCommand
799
+ description: The command, if any, to execute on the container.
800
+ ports:
801
+ type: object
802
+ title: ContainerPorts
803
+ description: The container's port mappings, if any.
804
+ volumes:
805
+ type: object
806
+ title: ContainerVolumes
807
+ description: The container's volume mappings, if any.
808
+ environment:
809
+ type: object
810
+ title: ContainerEnvironment
811
+ description: A key/value mapping of the environment variables, if any, to use when running the configured process.
812
+ stdin:
813
+ type: string
814
+ title: ContainerStdin
815
+ description: A runtime expression, if any, passed as standard input (stdin) to the command or default container CMD
816
+ arguments:
817
+ type: array
818
+ title: ContainerArguments
819
+ description: A list of the arguments, if any, passed as argv to the command or default container CMD
820
+ items:
821
+ type: string
822
+ lifetime:
823
+ $ref: '#/$defs/containerLifetime'
824
+ title: ContainerLifetime
825
+ description: An object, if any, used to configure the container's lifetime
826
+ pullPolicy:
827
+ type: string
828
+ title: ContainerPullPolicy
829
+ description: Policy that controls how the container's image should be pulled from the registry. Defaults to `ifNotPresent`
830
+ enum: [ ifNotPresent, always, never ]
831
+ required: [ image ]
832
+ required: [ container ]
833
+ - title: RunScript
834
+ description: Enables the execution of custom scripts or code within a workflow, empowering workflows to perform specialized logic, data processing, or integration tasks by executing user-defined scripts written in various programming languages.
835
+ properties:
836
+ script:
837
+ type: object
838
+ title: Script
839
+ description: The configuration of the script to run.
840
+ unevaluatedProperties: false
841
+ properties:
842
+ language:
843
+ type: string
844
+ title: ScriptLanguage
845
+ description: The language of the script to run.
846
+ stdin:
847
+ type: string
848
+ title: ScriptStdin
849
+ description: A runtime expression, if any, to the script as standard input (stdin).
850
+ arguments:
851
+ type: array
852
+ title: ScriptArguments
853
+ description: A list of the arguments, if any, to the script as argv
854
+ items:
855
+ type: string
856
+ environment:
857
+ type: object
858
+ title: ScriptEnvironment
859
+ description: A key/value mapping of the environment variables, if any, to use when running the configured script process.
860
+ additionalProperties: true
861
+ oneOf:
862
+ - title: InlineScript
863
+ type: object
864
+ description: The script's code.
865
+ properties:
866
+ code:
867
+ type: string
868
+ title: InlineScriptCode
869
+ required: [ code ]
870
+ - title: ExternalScript
871
+ type: object
872
+ description: The script's resource.
873
+ properties:
874
+ source:
875
+ $ref: '#/$defs/externalResource'
876
+ title: ExternalScriptResource
877
+ required: [ source ]
878
+ required: [ language ]
879
+ required: [ script ]
880
+ - title: RunShell
881
+ description: Enables the execution of shell commands within a workflow, enabling workflows to interact with the underlying operating system and perform system-level operations, such as file manipulation, environment configuration, or system administration tasks.
882
+ properties:
883
+ shell:
884
+ type: object
885
+ title: Shell
886
+ description: The configuration of the shell command to run.
887
+ unevaluatedProperties: false
888
+ properties:
889
+ command:
890
+ type: string
891
+ title: ShellCommand
892
+ description: The shell command to run.
893
+ stdin:
894
+ type: string
895
+ title: ShellStdin
896
+ description: A runtime expression, if any, to the shell command as standard input (stdin).
897
+ arguments:
898
+ type: array
899
+ title: ShellArguments
900
+ description: A list of the arguments, if any, to the shell command as argv
901
+ items:
902
+ type: string
903
+ environment:
904
+ type: object
905
+ title: ShellEnvironment
906
+ description: A key/value mapping of the environment variables, if any, to use when running the configured process.
907
+ additionalProperties: true
908
+ required: [ command ]
909
+ required: [ shell ]
910
+ - title: RunWorkflow
911
+ description: Enables the invocation and execution of nested workflows within a parent workflow, facilitating modularization, reusability, and abstraction of complex logic or business processes by encapsulating them into standalone workflow units.
912
+ properties:
913
+ workflow:
914
+ type: object
915
+ title: SubflowConfiguration
916
+ description: The configuration of the workflow to run.
917
+ unevaluatedProperties: false
918
+ properties:
919
+ namespace:
920
+ type: string
921
+ title: SubflowNamespace
922
+ description: The namespace the workflow to run belongs to.
923
+ name:
924
+ type: string
925
+ title: SubflowName
926
+ description: The name of the workflow to run.
927
+ version:
928
+ type: string
929
+ default: latest
930
+ title: SubflowVersion
931
+ description: The version of the workflow to run. Defaults to latest.
932
+ input:
933
+ type: object
934
+ title: SubflowInput
935
+ description: The data, if any, to pass as input to the workflow to execute. The value should be validated against the target workflow's input schema, if specified.
936
+ additionalProperties: true
937
+ required: [ namespace, name, version ]
938
+ required: [ workflow ]
939
+ setTask:
940
+ type: object
941
+ title: SetTask
942
+ description: A task used to set data.
943
+ required: [ set ]
944
+ unevaluatedProperties: false
945
+ allOf:
946
+ - $ref: '#/$defs/taskBase'
947
+ - properties:
948
+ set:
949
+ oneOf:
950
+ - type: object
951
+ minProperties: 1
952
+ additionalProperties: true
953
+ - type: string
954
+ title: SetTaskConfiguration
955
+ description: The data to set.
956
+ switchTask:
957
+ type: object
958
+ title: SwitchTask
959
+ description: Enables conditional branching within workflows, allowing them to dynamically select different paths based on specified conditions or criteria.
960
+ required: [ switch ]
961
+ unevaluatedProperties: false
962
+ allOf:
963
+ - $ref: '#/$defs/taskBase'
964
+ - properties:
965
+ switch:
966
+ type: array
967
+ title: SwitchTaskConfiguration
968
+ description: The definition of the switch to use.
969
+ minItems: 1
970
+ items:
971
+ type: object
972
+ title: SwitchItem
973
+ minProperties: 1
974
+ maxProperties: 1
975
+ additionalProperties:
976
+ type: object
977
+ title: SwitchCase
978
+ description: The definition of a case within a switch task, defining a condition and corresponding tasks to execute if the condition is met.
979
+ unevaluatedProperties: false
980
+ required: [ then ]
981
+ properties:
982
+ when:
983
+ type: string
984
+ title: SwitchCaseCondition
985
+ description: A runtime expression used to determine whether or not the case matches.
986
+ then:
987
+ $ref: '#/$defs/flowDirective'
988
+ title: SwitchCaseOutcome
989
+ description: The flow directive to execute when the case matches.
990
+ tryTask:
991
+ type: object
992
+ title: TryTask
993
+ description: Serves as a mechanism within workflows to handle errors gracefully, potentially retrying failed tasks before proceeding with alternate ones.
994
+ required: [ try, catch ]
995
+ unevaluatedProperties: false
996
+ allOf:
997
+ - $ref: '#/$defs/taskBase'
998
+ - properties:
999
+ try:
1000
+ $ref: '#/$defs/taskList'
1001
+ title: TryTaskConfiguration
1002
+ description: The task(s) to perform.
1003
+ catch:
1004
+ type: object
1005
+ title: TryTaskCatch
1006
+ description: The object used to define the errors to catch.
1007
+ unevaluatedProperties: false
1008
+ properties:
1009
+ errors:
1010
+ type: object
1011
+ title: CatchErrors
1012
+ properties:
1013
+ with:
1014
+ $ref: '#/$defs/errorFilter'
1015
+ description: static error filter
1016
+ as:
1017
+ type: string
1018
+ title: CatchAs
1019
+ description: The name of the runtime expression variable to save the error as. Defaults to 'error'.
1020
+ when:
1021
+ type: string
1022
+ title: CatchWhen
1023
+ description: A runtime expression used to determine whether to catch the filtered error.
1024
+ exceptWhen:
1025
+ type: string
1026
+ title: CatchExceptWhen
1027
+ description: A runtime expression used to determine whether not to catch the filtered error.
1028
+ retry:
1029
+ oneOf:
1030
+ - $ref: '#/$defs/retryPolicy'
1031
+ title: RetryPolicyDefinition
1032
+ description: The retry policy to use, if any, when catching errors.
1033
+ - type: string
1034
+ title: RetryPolicyReference
1035
+ description: The name of the retry policy to use, if any, when catching errors.
1036
+ do:
1037
+ $ref: '#/$defs/taskList'
1038
+ title: TryTaskCatchDo
1039
+ description: The definition of the task(s) to run when catching an error.
1040
+ waitTask:
1041
+ type: object
1042
+ title: WaitTask
1043
+ description: Allows workflows to pause or delay their execution for a specified period of time.
1044
+ required: [ wait ]
1045
+ unevaluatedProperties: false
1046
+ allOf:
1047
+ - $ref: '#/$defs/taskBase'
1048
+ - properties:
1049
+ wait:
1050
+ $ref: '#/$defs/duration'
1051
+ title: WaitTaskConfiguration
1052
+ description: The amount of time to wait.
1053
+ flowDirective:
1054
+ title: FlowDirective
1055
+ description: Represents different transition options for a workflow.
1056
+ anyOf:
1057
+ - title: FlowDirectiveEnum
1058
+ type: string
1059
+ enum: [ continue, exit, end ]
1060
+ default: continue
1061
+ - type: string
1062
+ referenceableAuthenticationPolicy:
1063
+ type: object
1064
+ title: ReferenceableAuthenticationPolicy
1065
+ description: Represents a referenceable authentication policy.
1066
+ unevaluatedProperties: false
1067
+ oneOf:
1068
+ - title: AuthenticationPolicyReference
1069
+ description: The reference of the authentication policy to use.
1070
+ properties:
1071
+ use:
1072
+ type: string
1073
+ minLength: 1
1074
+ title: ReferenceableAuthenticationPolicyName
1075
+ description: The name of the authentication policy to use.
1076
+ required: [use]
1077
+ - $ref: '#/$defs/authenticationPolicy'
1078
+ secretBasedAuthenticationPolicy:
1079
+ type: object
1080
+ title: SecretBasedAuthenticationPolicy
1081
+ description: Represents an authentication policy based on secrets.
1082
+ unevaluatedProperties: false
1083
+ properties:
1084
+ use:
1085
+ type: string
1086
+ minLength: 1
1087
+ title: SecretBasedAuthenticationPolicyName
1088
+ description: The name of the authentication policy to use.
1089
+ required: [use]
1090
+ authenticationPolicy:
1091
+ type: object
1092
+ title: AuthenticationPolicy
1093
+ description: Defines an authentication policy.
1094
+ oneOf:
1095
+ - title: BasicAuthenticationPolicy
1096
+ description: Use basic authentication.
1097
+ properties:
1098
+ basic:
1099
+ type: object
1100
+ title: BasicAuthenticationPolicyConfiguration
1101
+ description: The configuration of the basic authentication policy.
1102
+ unevaluatedProperties: false
1103
+ oneOf:
1104
+ - title: BasicAuthenticationProperties
1105
+ description: Inline configuration of the basic authentication policy.
1106
+ properties:
1107
+ username:
1108
+ type: string
1109
+ description: The username to use.
1110
+ password:
1111
+ type: string
1112
+ description: The password to use.
1113
+ required: [ username, password ]
1114
+ - $ref: '#/$defs/secretBasedAuthenticationPolicy'
1115
+ title: BasicAuthenticationPolicySecret
1116
+ description: Secret based configuration of the basic authentication policy.
1117
+ required: [ basic ]
1118
+ - title: BearerAuthenticationPolicy
1119
+ description: Use bearer authentication.
1120
+ properties:
1121
+ bearer:
1122
+ type: object
1123
+ title: BearerAuthenticationPolicyConfiguration
1124
+ description: The configuration of the bearer authentication policy.
1125
+ unevaluatedProperties: false
1126
+ oneOf:
1127
+ - title: BearerAuthenticationProperties
1128
+ description: Inline configuration of the bearer authentication policy.
1129
+ properties:
1130
+ token:
1131
+ type: string
1132
+ description: The bearer token to use.
1133
+ required: [ token ]
1134
+ - $ref: '#/$defs/secretBasedAuthenticationPolicy'
1135
+ title: BearerAuthenticationPolicySecret
1136
+ description: Secret based configuration of the bearer authentication policy.
1137
+ required: [ bearer ]
1138
+ - title: DigestAuthenticationPolicy
1139
+ description: Use digest authentication.
1140
+ properties:
1141
+ digest:
1142
+ type: object
1143
+ title: DigestAuthenticationPolicyConfiguration
1144
+ description: The configuration of the digest authentication policy.
1145
+ unevaluatedProperties: false
1146
+ oneOf:
1147
+ - title: DigestAuthenticationProperties
1148
+ description: Inline configuration of the digest authentication policy.
1149
+ properties:
1150
+ username:
1151
+ type: string
1152
+ description: The username to use.
1153
+ password:
1154
+ type: string
1155
+ description: The password to use.
1156
+ required: [ username, password ]
1157
+ - $ref: '#/$defs/secretBasedAuthenticationPolicy'
1158
+ title: DigestAuthenticationPolicySecret
1159
+ description: Secret based configuration of the digest authentication policy.
1160
+ required: [ digest ]
1161
+ - title: OAuth2AuthenticationPolicy
1162
+ description: Use OAuth2 authentication.
1163
+ properties:
1164
+ oauth2:
1165
+ type: object
1166
+ title: OAuth2AuthenticationPolicyConfiguration
1167
+ description: The configuration of the OAuth2 authentication policy.
1168
+ unevaluatedProperties: false
1169
+ oneOf:
1170
+ - $ref: '#/$defs/oauth2AuthenticationProperties'
1171
+ type: object
1172
+ title: OAuth2ConnectAuthenticationProperties
1173
+ description: The inline configuration of the OAuth2 authentication policy.
1174
+ unevaluatedProperties: false
1175
+ properties:
1176
+ endpoints:
1177
+ type: object
1178
+ title: OAuth2AuthenticationPropertiesEndpoints
1179
+ description: The endpoint configurations for OAuth2.
1180
+ properties:
1181
+ token:
1182
+ type: string
1183
+ format: uri-template
1184
+ default: /oauth2/token
1185
+ title: OAuth2TokenEndpoint
1186
+ description: The relative path to the token endpoint. Defaults to `/oauth2/token`.
1187
+ revocation:
1188
+ type: string
1189
+ format: uri-template
1190
+ default: /oauth2/revoke
1191
+ title: OAuth2RevocationEndpoint
1192
+ description: The relative path to the revocation endpoint. Defaults to `/oauth2/revoke`.
1193
+ introspection:
1194
+ type: string
1195
+ format: uri-template
1196
+ default: /oauth2/introspect
1197
+ title: OAuth2IntrospectionEndpoint
1198
+ description: The relative path to the introspection endpoint. Defaults to `/oauth2/introspect`.
1199
+ - $ref: '#/$defs/secretBasedAuthenticationPolicy'
1200
+ title: OAuth2AuthenticationPolicySecret
1201
+ description: Secret based configuration of the OAuth2 authentication policy.
1202
+ required: [ oauth2 ]
1203
+ - title: OpenIdConnectAuthenticationPolicy
1204
+ description: Use OpenIdConnect authentication.
1205
+ properties:
1206
+ oidc:
1207
+ type: object
1208
+ title: OpenIdConnectAuthenticationPolicyConfiguration
1209
+ description: The configuration of the OpenIdConnect authentication policy.
1210
+ unevaluatedProperties: false
1211
+ oneOf:
1212
+ - $ref: '#/$defs/oauth2AuthenticationProperties'
1213
+ title: OpenIdConnectAuthenticationProperties
1214
+ description: The inline configuration of the OpenIdConnect authentication policy.
1215
+ unevaluatedProperties: false
1216
+ - $ref: '#/$defs/secretBasedAuthenticationPolicy'
1217
+ title: OpenIdConnectAuthenticationPolicySecret
1218
+ description: Secret based configuration of the OpenIdConnect authentication policy.
1219
+ required: [ oidc ]
1220
+ oauth2AuthenticationProperties:
1221
+ type: object
1222
+ title: OAuth2AuthenticationData
1223
+ description: Inline configuration of the OAuth2 authentication policy.
1224
+ properties:
1225
+ authority:
1226
+ $ref: '#/$defs/uriTemplate'
1227
+ title: OAuth2AuthenticationDataAuthority
1228
+ description: The URI that references the OAuth2 authority to use.
1229
+ grant:
1230
+ type: string
1231
+ enum: [ authorization_code, client_credentials, password, refresh_token, 'urn:ietf:params:oauth:grant-type:token-exchange']
1232
+ title: OAuth2AuthenticationDataGrant
1233
+ description: The grant type to use.
1234
+ client:
1235
+ type: object
1236
+ title: OAuth2AuthenticationDataClient
1237
+ description: The definition of an OAuth2 client.
1238
+ unevaluatedProperties: false
1239
+ properties:
1240
+ id:
1241
+ type: string
1242
+ title: ClientId
1243
+ description: The client id to use.
1244
+ secret:
1245
+ type: string
1246
+ title: ClientSecret
1247
+ description: The client secret to use, if any.
1248
+ assertion:
1249
+ type: string
1250
+ title: ClientAssertion
1251
+ description: A JWT containing a signed assertion with your application credentials.
1252
+ authentication:
1253
+ type: string
1254
+ enum: [ client_secret_basic, client_secret_post, client_secret_jwt, private_key_jwt, none ]
1255
+ default: client_secret_post
1256
+ title: ClientAuthentication
1257
+ description: The authentication method to use to authenticate the client.
1258
+ request:
1259
+ type: object
1260
+ title: OAuth2TokenRequest
1261
+ description: The configuration of an OAuth2 token request
1262
+ properties:
1263
+ encoding:
1264
+ type: string
1265
+ enum: [ 'application/x-www-form-urlencoded', 'application/json' ]
1266
+ default: 'application/x-www-form-urlencoded'
1267
+ title: Oauth2TokenRequestEncoding
1268
+ issuers:
1269
+ type: array
1270
+ title: OAuth2Issuers
1271
+ description: A list that contains that contains valid issuers that will be used to check against the issuer of generated tokens.
1272
+ items:
1273
+ type: string
1274
+ scopes:
1275
+ type: array
1276
+ title: OAuth2AuthenticationDataScopes
1277
+ description: The scopes, if any, to request the token for.
1278
+ items:
1279
+ type: string
1280
+ audiences:
1281
+ type: array
1282
+ title: OAuth2AuthenticationDataAudiences
1283
+ description: The audiences, if any, to request the token for.
1284
+ items:
1285
+ type: string
1286
+ username:
1287
+ type: string
1288
+ title: OAuth2AuthenticationDataUsername
1289
+ description: The username to use. Used only if the grant type is Password.
1290
+ password:
1291
+ type: string
1292
+ title: OAuth2AuthenticationDataPassword
1293
+ description: The password to use. Used only if the grant type is Password.
1294
+ subject:
1295
+ $ref: '#/$defs/oauth2Token'
1296
+ title: OAuth2AuthenticationDataSubject
1297
+ description: The security token that represents the identity of the party on behalf of whom the request is being made.
1298
+ actor:
1299
+ $ref: '#/$defs/oauth2Token'
1300
+ title: OAuth2AuthenticationDataActor
1301
+ description: The security token that represents the identity of the acting party.
1302
+ oauth2Token:
1303
+ type: object
1304
+ title: OAuth2TokenDefinition
1305
+ description: Represents an OAuth2 token.
1306
+ unevaluatedProperties: false
1307
+ properties:
1308
+ token:
1309
+ type: string
1310
+ title: OAuth2Token
1311
+ description: The security token to use.
1312
+ type:
1313
+ type: string
1314
+ title: OAuth2TokenType
1315
+ description: The type of the security token to use.
1316
+ required: [ token, type ]
1317
+ duration:
1318
+ oneOf:
1319
+ - type: object
1320
+ minProperties: 1
1321
+ unevaluatedProperties: false
1322
+ properties:
1323
+ days:
1324
+ type: integer
1325
+ title: DurationDays
1326
+ description: Number of days, if any.
1327
+ hours:
1328
+ type: integer
1329
+ title: DurationHours
1330
+ description: Number of days, if any.
1331
+ minutes:
1332
+ type: integer
1333
+ title: DurationMinutes
1334
+ description: Number of minutes, if any.
1335
+ seconds:
1336
+ type: integer
1337
+ title: DurationSeconds
1338
+ description: Number of seconds, if any.
1339
+ milliseconds:
1340
+ type: integer
1341
+ title: DurationMilliseconds
1342
+ description: Number of milliseconds, if any.
1343
+ title: DurationInline
1344
+ description: The inline definition of a duration.
1345
+ - $ref: '#/$defs/runtimeExpression'
1346
+ title: DurationExpression
1347
+ description: Runtime expression that generates an ISO 8601
1348
+ - type: string
1349
+ pattern: '^P(?!$)(\d+(?:\.\d+)?Y)?(\d+(?:\.\d+)?M)?(\d+(?:\.\d+)?W)?(\d+(?:\.\d+)?D)?(T(?=\d)(\d+(?:\.\d+)?H)?(\d+(?:\.\d+)?M)?(\d+(?:\.\d+)?S)?)?$'
1350
+ title: DurationLiteral
1351
+ description: The Literal ISO 8601 representation of a duration.
1352
+ error:
1353
+ type: object
1354
+ title: Error
1355
+ description: Represents an error.
1356
+ unevaluatedProperties: false
1357
+ properties:
1358
+ type:
1359
+ title: ErrorType
1360
+ description: A URI reference that identifies the error type.
1361
+ oneOf:
1362
+ - title: LiteralErrorType
1363
+ $ref: '#/$defs/uriTemplate'
1364
+ description: The literal error type.
1365
+ - title: ExpressionErrorType
1366
+ $ref: '#/$defs/runtimeExpression'
1367
+ description: An expression based error type.
1368
+ status:
1369
+ type: integer
1370
+ title: ErrorStatus
1371
+ description: The status code generated by the origin for this occurrence of the error.
1372
+ instance:
1373
+ title: ErrorInstance
1374
+ description: A JSON Pointer used to reference the component the error originates from.
1375
+ oneOf:
1376
+ - title: LiteralErrorInstance
1377
+ description: The literal error instance.
1378
+ type: string
1379
+ format: json-pointer
1380
+ - $ref: '#/$defs/runtimeExpression'
1381
+ title: ExpressionErrorInstance
1382
+ description: An expression based error instance.
1383
+ title:
1384
+ description: A short, human-readable summary of the error.
1385
+ title: ErrorTitle
1386
+ anyOf:
1387
+ - $ref: '#/$defs/runtimeExpression'
1388
+ title: ExpressionErrorTitle
1389
+ - type: string
1390
+ title: LiteralErrorTitle
1391
+ detail:
1392
+ title: ErrorDetails
1393
+ description: A human-readable explanation specific to this occurrence of the error.
1394
+ anyOf:
1395
+ - $ref: '#/$defs/runtimeExpression'
1396
+ title: ExpressionErrorDetails
1397
+ - type: string
1398
+ title: LiteralErrorDetails
1399
+ required: [ type, status ]
1400
+ errorFilter:
1401
+ type: object
1402
+ title: ErrorFilter
1403
+ description: Error filtering base on static values. For error filtering on dynamic values, use catch.when property
1404
+ minProperties: 1
1405
+ properties:
1406
+ type:
1407
+ type: string
1408
+ description: if present, means this value should be used for filtering
1409
+ status:
1410
+ type: integer
1411
+ description: if present, means this value should be used for filtering
1412
+ instance:
1413
+ type: string
1414
+ description: if present, means this value should be used for filtering
1415
+ title:
1416
+ type: string
1417
+ description: if present, means this value should be used for filtering
1418
+ details:
1419
+ type: string
1420
+ description: if present, means this value should be used for filtering
1421
+ uriTemplate:
1422
+ title: UriTemplate
1423
+ anyOf:
1424
+ - title: LiteralUriTemplate
1425
+ type: string
1426
+ format: uri-template
1427
+ pattern: "^[A-Za-z][A-Za-z0-9+\\-.]*://.*"
1428
+ - title: LiteralUri
1429
+ type: string
1430
+ format: uri
1431
+ pattern: "^[A-Za-z][A-Za-z0-9+\\-.]*://.*"
1432
+ endpoint:
1433
+ title: Endpoint
1434
+ description: Represents an endpoint.
1435
+ oneOf:
1436
+ - $ref: '#/$defs/runtimeExpression'
1437
+ - $ref: '#/$defs/uriTemplate'
1438
+ - title: EndpointConfiguration
1439
+ type: object
1440
+ unevaluatedProperties: false
1441
+ properties:
1442
+ uri:
1443
+ title: EndpointUri
1444
+ description: The endpoint's URI.
1445
+ oneOf:
1446
+ - title: LiteralEndpointURI
1447
+ description: The literal endpoint's URI.
1448
+ $ref: '#/$defs/uriTemplate'
1449
+ - title: ExpressionEndpointURI
1450
+ $ref: '#/$defs/runtimeExpression'
1451
+ description: An expression based endpoint's URI.
1452
+ authentication:
1453
+ $ref: '#/$defs/referenceableAuthenticationPolicy'
1454
+ title: EndpointAuthentication
1455
+ description: The authentication policy to use.
1456
+ required: [ uri ]
1457
+ eventProperties:
1458
+ type: object
1459
+ title: EventProperties
1460
+ description: Describes the properties of an event.
1461
+ properties:
1462
+ id:
1463
+ type: string
1464
+ title: EventId
1465
+ description: The event's unique identifier.
1466
+ source:
1467
+ title: EventSource
1468
+ description: Identifies the context in which an event happened.
1469
+ oneOf:
1470
+ - $ref: '#/$defs/uriTemplate'
1471
+ - $ref: '#/$defs/runtimeExpression'
1472
+ type:
1473
+ type: string
1474
+ title: EventType
1475
+ description: This attribute contains a value describing the type of event related to the originating occurrence.
1476
+ time:
1477
+ title: EventTime
1478
+ description: When the event occured.
1479
+ oneOf:
1480
+ - title: LiteralTime
1481
+ type: string
1482
+ format: date-time
1483
+ - $ref: '#/$defs/runtimeExpression'
1484
+ subject:
1485
+ type: string
1486
+ title: EventSubject
1487
+ description: The subject of the event.
1488
+ datacontenttype:
1489
+ type: string
1490
+ title: EventDataContentType
1491
+ description: Content type of data value. This attribute enables data to carry any type of content, whereby format and encoding might differ from that of the chosen event format.
1492
+ dataschema:
1493
+ title: EventDataschema
1494
+ description: The schema describing the event format.
1495
+ oneOf:
1496
+ - title: LiteralDataSchema
1497
+ $ref: '#/$defs/uriTemplate'
1498
+ description: The literal event data schema.
1499
+ - title: ExpressionDataSchema
1500
+ $ref: '#/$defs/runtimeExpression'
1501
+ description: An expression based event data schema.
1502
+ data:
1503
+ title: EventData
1504
+ description: The event's payload data
1505
+ anyOf:
1506
+ - $ref: '#/$defs/runtimeExpression'
1507
+ - {}
1508
+ additionalProperties: true
1509
+ eventConsumptionStrategy:
1510
+ type: object
1511
+ title: EventConsumptionStrategy
1512
+ description: Describe the event consumption strategy to adopt.
1513
+ unevaluatedProperties: false
1514
+ oneOf:
1515
+ - title: AllEventConsumptionStrategy
1516
+ properties:
1517
+ all:
1518
+ type: array
1519
+ title: AllEventConsumptionStrategyConfiguration
1520
+ description: A list containing all the events that must be consumed.
1521
+ items:
1522
+ $ref: '#/$defs/eventFilter'
1523
+ required: [ all ]
1524
+ - title: AnyEventConsumptionStrategy
1525
+ properties:
1526
+ any:
1527
+ type: array
1528
+ title: AnyEventConsumptionStrategyConfiguration
1529
+ description: A list containing any of the events to consume.
1530
+ items:
1531
+ $ref: '#/$defs/eventFilter'
1532
+ until:
1533
+ oneOf:
1534
+ - type: string
1535
+ title: AnyEventUntilCondition
1536
+ description: A runtime expression condition evaluated after consuming an event and which determines whether or not to continue listening.
1537
+ - allOf:
1538
+ - $ref: '#/$defs/eventConsumptionStrategy'
1539
+ description: The strategy that defines the event(s) to consume to stop listening.
1540
+ - properties:
1541
+ until: false
1542
+ title: AnyEventUntilConsumed
1543
+ required: [ any ]
1544
+ - title: OneEventConsumptionStrategy
1545
+ properties:
1546
+ one:
1547
+ $ref: '#/$defs/eventFilter'
1548
+ title: OneEventConsumptionStrategyConfiguration
1549
+ description: The single event to consume.
1550
+ required: [ one ]
1551
+ eventFilter:
1552
+ type: object
1553
+ title: EventFilter
1554
+ description: An event filter is a mechanism used to selectively process or handle events based on predefined criteria, such as event type, source, or specific attributes.
1555
+ unevaluatedProperties: false
1556
+ properties:
1557
+ with:
1558
+ $ref: '#/$defs/eventProperties'
1559
+ minProperties: 1
1560
+ title: WithEvent
1561
+ description: An event filter is a mechanism used to selectively process or handle events based on predefined criteria, such as event type, source, or specific attributes.
1562
+ correlate:
1563
+ type: object
1564
+ title: EventFilterCorrelate
1565
+ description: A correlation is a link between events and data, established by mapping event attributes to specific data attributes, allowing for coordinated processing or handling based on event characteristics.
1566
+ additionalProperties:
1567
+ type: object
1568
+ properties:
1569
+ from:
1570
+ type: string
1571
+ title: CorrelateFrom
1572
+ description: A runtime expression used to extract the correlation value from the filtered event.
1573
+ expect:
1574
+ type: string
1575
+ title: CorrelateExpect
1576
+ description: A constant or a runtime expression, if any, used to determine whether or not the extracted correlation value matches expectations. If not set, the first extracted value will be used as the correlation's expectation.
1577
+ required: [ from ]
1578
+ required: [ with ]
1579
+ extension:
1580
+ type: object
1581
+ title: Extension
1582
+ description: The definition of an extension.
1583
+ unevaluatedProperties: false
1584
+ properties:
1585
+ extend:
1586
+ type: string
1587
+ enum: [ call, composite, emit, for, listen, raise, run, set, switch, try, wait, all ]
1588
+ title: ExtensionTarget
1589
+ description: The type of task to extend.
1590
+ when:
1591
+ type: string
1592
+ title: ExtensionCondition
1593
+ description: A runtime expression, if any, used to determine whether or not the extension should apply in the specified context.
1594
+ before:
1595
+ $ref: '#/$defs/taskList'
1596
+ title: ExtensionDoBefore
1597
+ description: The task(s) to execute before the extended task, if any.
1598
+ after:
1599
+ $ref: '#/$defs/taskList'
1600
+ title: ExtensionDoAfter
1601
+ description: The task(s) to execute after the extended task, if any.
1602
+ required: [ extend ]
1603
+ externalResource:
1604
+ type: object
1605
+ title: ExternalResource
1606
+ description: Represents an external resource.
1607
+ unevaluatedProperties: false
1608
+ properties:
1609
+ name:
1610
+ type: string
1611
+ title: ExternalResourceName
1612
+ description: The name of the external resource, if any.
1613
+ endpoint:
1614
+ $ref: '#/$defs/endpoint'
1615
+ title: ExternalResourceEndpoint
1616
+ description: The endpoint of the external resource.
1617
+ required: [ endpoint ]
1618
+ input:
1619
+ type: object
1620
+ title: Input
1621
+ description: Configures the input of a workflow or task.
1622
+ unevaluatedProperties: false
1623
+ properties:
1624
+ schema:
1625
+ $ref: '#/$defs/schema'
1626
+ title: InputSchema
1627
+ description: The schema used to describe and validate the input of the workflow or task.
1628
+ from:
1629
+ title: InputFrom
1630
+ description: A runtime expression, if any, used to mutate and/or filter the input of the workflow or task.
1631
+ oneOf:
1632
+ - type: string
1633
+ - type: object
1634
+ output:
1635
+ type: object
1636
+ title: Output
1637
+ description: Configures the output of a workflow or task.
1638
+ unevaluatedProperties: false
1639
+ properties:
1640
+ schema:
1641
+ $ref: '#/$defs/schema'
1642
+ title: OutputSchema
1643
+ description: The schema used to describe and validate the output of the workflow or task.
1644
+ as:
1645
+ title: OutputAs
1646
+ description: A runtime expression, if any, used to mutate and/or filter the output of the workflow or task.
1647
+ oneOf:
1648
+ - type: string
1649
+ - type: object
1650
+ export:
1651
+ type: object
1652
+ title: Export
1653
+ description: Set the content of the context. .
1654
+ unevaluatedProperties: false
1655
+ properties:
1656
+ schema:
1657
+ $ref: '#/$defs/schema'
1658
+ title: ExportSchema
1659
+ description: The schema used to describe and validate the workflow context.
1660
+ as:
1661
+ title: ExportAs
1662
+ description: A runtime expression, if any, used to export the output data to the context.
1663
+ oneOf:
1664
+ - type: string
1665
+ - type: object
1666
+ retryPolicy:
1667
+ type: object
1668
+ title: RetryPolicy
1669
+ description: Defines a retry policy.
1670
+ unevaluatedProperties: false
1671
+ properties:
1672
+ when:
1673
+ type: string
1674
+ title: RetryWhen
1675
+ description: A runtime expression, if any, used to determine whether or not to retry running the task, in a given context.
1676
+ exceptWhen:
1677
+ type: string
1678
+ title: RetryExcepWhen
1679
+ description: A runtime expression used to determine whether or not to retry running the task, in a given context.
1680
+ delay:
1681
+ $ref: '#/$defs/duration'
1682
+ title: RetryDelay
1683
+ description: The duration to wait between retry attempts.
1684
+ backoff:
1685
+ type: object
1686
+ title: RetryBackoff
1687
+ description: The retry duration backoff.
1688
+ unevaluatedProperties: false
1689
+ oneOf:
1690
+ - title: ConstantBackoff
1691
+ properties:
1692
+ constant:
1693
+ type: object
1694
+ description: The definition of the constant backoff to use, if any.
1695
+ required: [ constant ]
1696
+ - title: ExponentialBackOff
1697
+ properties:
1698
+ exponential:
1699
+ type: object
1700
+ description: The definition of the exponential backoff to use, if any.
1701
+ required: [ exponential ]
1702
+ - title: LinearBackoff
1703
+ properties:
1704
+ linear:
1705
+ type: object
1706
+ description: The definition of the linear backoff to use, if any.
1707
+ required: [ linear ]
1708
+ limit:
1709
+ type: object
1710
+ title: RetryLimit
1711
+ unevaluatedProperties: false
1712
+ properties:
1713
+ attempt:
1714
+ type: object
1715
+ title: RetryLimitAttempt
1716
+ unevaluatedProperties: false
1717
+ properties:
1718
+ count:
1719
+ type: integer
1720
+ title: RetryLimitAttemptCount
1721
+ description: The maximum amount of retry attempts, if any.
1722
+ duration:
1723
+ $ref: '#/$defs/duration'
1724
+ title: RetryLimitAttemptDuration
1725
+ description: The maximum duration for each retry attempt.
1726
+ duration:
1727
+ $ref: '#/$defs/duration'
1728
+ title: RetryLimitDuration
1729
+ description: The duration limit, if any, for all retry attempts.
1730
+ description: The retry limit, if any.
1731
+ jitter:
1732
+ type: object
1733
+ title: RetryPolicyJitter
1734
+ description: The parameters, if any, that control the randomness or variability of the delay between retry attempts.
1735
+ unevaluatedProperties: false
1736
+ properties:
1737
+ from:
1738
+ $ref: '#/$defs/duration'
1739
+ title: RetryPolicyJitterFrom
1740
+ description: The minimum duration of the jitter range.
1741
+ to:
1742
+ $ref: '#/$defs/duration'
1743
+ title: RetryPolicyJitterTo
1744
+ description: The maximum duration of the jitter range.
1745
+ required: [ from, to ]
1746
+ schema:
1747
+ type: object
1748
+ title: Schema
1749
+ description: Represents the definition of a schema.
1750
+ unevaluatedProperties: false
1751
+ properties:
1752
+ format:
1753
+ type: string
1754
+ default: json
1755
+ title: SchemaFormat
1756
+ description: The schema's format. Defaults to 'json'. The (optional) version of the format can be set using `{format}:{version}`.
1757
+ oneOf:
1758
+ - title: SchemaInline
1759
+ properties:
1760
+ document:
1761
+ description: The schema's inline definition.
1762
+ required: [ document ]
1763
+ - title: SchemaExternal
1764
+ properties:
1765
+ resource:
1766
+ $ref: '#/$defs/externalResource'
1767
+ title: SchemaExternalResource
1768
+ description: The schema's external resource.
1769
+ required: [ resource ]
1770
+ timeout:
1771
+ type: object
1772
+ title: Timeout
1773
+ description: The definition of a timeout.
1774
+ unevaluatedProperties: false
1775
+ properties:
1776
+ after:
1777
+ $ref: '#/$defs/duration'
1778
+ title: TimeoutAfter
1779
+ description: The duration after which to timeout.
1780
+ required: [ after ]
1781
+ catalog:
1782
+ type: object
1783
+ title: Catalog
1784
+ description: The definition of a resource catalog.
1785
+ unevaluatedProperties: false
1786
+ properties:
1787
+ endpoint:
1788
+ $ref: '#/$defs/endpoint'
1789
+ title: CatalogEndpoint
1790
+ description: The root URL where the catalog is hosted.
1791
+ required: [ endpoint ]
1792
+ runtimeExpression:
1793
+ type: string
1794
+ title: RuntimeExpression
1795
+ description: A runtime expression.
1796
+ pattern: "^\\s*\\$\\{.+\\}\\s*$"
1797
+ containerLifetime:
1798
+ type: object
1799
+ title: ContainerLifetime
1800
+ description: The configuration of a container's lifetime
1801
+ unevaluatedProperties: false
1802
+ properties:
1803
+ cleanup:
1804
+ type: string
1805
+ title: ContainerCleanupPolicy
1806
+ description: The container cleanup policy to use
1807
+ enum: [ always, never, eventually ]
1808
+ default: never
1809
+ after:
1810
+ $ref: '#/$defs/duration'
1811
+ title: ContainerLifetimeDuration
1812
+ description: The duration after which to cleanup the container, in case the cleanup policy has been set to 'eventually'
1813
+ required: [ cleanup ]
1814
+ if:
1815
+ properties:
1816
+ cleanup:
1817
+ const: eventually
1818
+ then:
1819
+ required: [ after ]
1820
+ else:
1821
+ not:
1822
+ required: [ after ]
1823
+ processResult:
1824
+ type: object
1825
+ title: ProcessResult
1826
+ description: The object returned by a run task when its return type has been set 'all'.
1827
+ unevaluatedProperties: false
1828
+ properties:
1829
+ code:
1830
+ type: integer
1831
+ title: ProcessExitCode
1832
+ description: The process's exit code.
1833
+ stdout:
1834
+ type: string
1835
+ title: ProcessStandardOutput
1836
+ description: The content of the process's STDOUT.
1837
+ stderr:
1838
+ type: string
1839
+ title: ProcessStandardError
1840
+ description: The content of the process's STDERR.
1841
+ required: [ code, stdout, stderr ]
1842
+ asyncApiServer:
1843
+ type: object
1844
+ title: AsyncApiServer
1845
+ description: Configures the target server of an AsyncAPI operation.
1846
+ unevaluatedProperties: false
1847
+ properties:
1848
+ name:
1849
+ type: string
1850
+ title: AsyncApiServerName
1851
+ description: The target server's name.
1852
+ variables:
1853
+ type: object
1854
+ title: AsyncApiServerVariables
1855
+ description: The target server's variables, if any.
1856
+ required: [ name ]
1857
+ asyncApiOutboundMessage:
1858
+ type: object
1859
+ title: AsyncApiOutboundMessage
1860
+ description: An object used to configure the message to publish using the target operation.
1861
+ unevaluatedProperties: false
1862
+ properties:
1863
+ payload:
1864
+ type: object
1865
+ title: AsyncApiMessagePayload
1866
+ description: The message's payload, if any.
1867
+ headers:
1868
+ type: object
1869
+ title: AsyncApiMessageHeaders
1870
+ description: The message's headers, if any.
1871
+ asyncApiInboundMessage:
1872
+ title: AsyncApiInboundMessage
1873
+ description: Represents a message counsumed by an AsyncAPI subscription.
1874
+ allOf:
1875
+ - $ref: '#/$defs/asyncApiOutboundMessage'
1876
+ - properties:
1877
+ correlationId:
1878
+ type: string
1879
+ title: AsyncApiMessageCorrelationId
1880
+ description: The message's correlation id, if any.
1881
+ asyncApiSubscription:
1882
+ type: object
1883
+ title: AsyncApiSubscription
1884
+ description: An object used to configure the subscription to messages consumed using the target operation.
1885
+ unevaluatedProperties: false
1886
+ properties:
1887
+ filter:
1888
+ $ref: '#/$defs/runtimeExpression'
1889
+ title: AsyncApiSubscriptionCorrelation
1890
+ description: A runtime expression, if any, used to filter consumed messages.
1891
+ consume:
1892
+ $ref: '#/$defs/asyncApiMessageConsumptionPolicy'
1893
+ title: AsyncApiMessageConsumptionPolicy
1894
+ description: An object used to configure the subscription's message consumption policy.
1895
+ foreach:
1896
+ $ref: '#/$defs/subscriptionIterator'
1897
+ title: AsyncApiSubscriptionIterator
1898
+ description: Configures the iterator, if any, for processing consumed messages(s).
1899
+ required: [ consume ]
1900
+ asyncApiMessageConsumptionPolicy:
1901
+ type: object
1902
+ title: AsyncApiMessageConsumptionPolicy
1903
+ description: An object used to configure a subscription's message consumption policy.
1904
+ unevaluatedProperties: false
1905
+ properties:
1906
+ for:
1907
+ $ref: '#/$defs/duration'
1908
+ title: AsyncApiMessageConsumptionPolicyFor
1909
+ description: Specifies the time period over which messages will be consumed.
1910
+ oneOf:
1911
+ - properties:
1912
+ amount:
1913
+ type: integer
1914
+ description: The amount of (filtered) messages to consume before disposing of the subscription.
1915
+ title: AsyncApiMessageConsumptionPolicyAmount
1916
+ required: [ amount ]
1917
+ - properties:
1918
+ while:
1919
+ $ref: '#/$defs/runtimeExpression'
1920
+ description: A runtime expression evaluated after each consumed (filtered) message to decide if message consumption should continue.
1921
+ title: AsyncApiMessageConsumptionPolicyWhile
1922
+ required: [ while ]
1923
+ - properties:
1924
+ until:
1925
+ $ref: '#/$defs/runtimeExpression'
1926
+ description: A runtime expression evaluated before each consumed (filtered) message to decide if message consumption should continue.
1927
+ title: AsyncApiMessageConsumptionPolicyUntil
1928
+ required: [ until ]
1929
+ subscriptionIterator:
1930
+ type: object
1931
+ title: SubscriptionIterator
1932
+ description: Configures the iteration over each item (event or message) consumed by a subscription.
1933
+ unevaluatedProperties: false
1934
+ properties:
1935
+ item:
1936
+ type: string
1937
+ title: SubscriptionIteratorItem
1938
+ description: The name of the variable used to store the current item being enumerated.
1939
+ default: item
1940
+ at:
1941
+ type: string
1942
+ title: SubscriptionIteratorIndex
1943
+ description: The name of the variable used to store the index of the current item being enumerated.
1944
+ default: index
1945
+ do:
1946
+ $ref: '#/$defs/taskList'
1947
+ title: SubscriptionIteratorTasks
1948
+ description: The tasks to perform for each consumed item.
1949
+ output:
1950
+ $ref: '#/$defs/output'
1951
+ title: SubscriptionIteratorOutput
1952
+ description: An object, if any, used to customize the item's output and to document its schema.
1953
+ export:
1954
+ $ref: '#/$defs/export'
1955
+ title: SubscriptionIteratorExport
1956
+ description: An object, if any, used to customize the content of the workflow context.