You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!--The comment below is left intentionally in case jsonschema2pojo one day accepts https urls. That day we can remove the file from schema dir and use directly the real schema-->
Copy file name to clipboardExpand all lines: api/src/main/resources/schema/workflow.yaml
+102-59
Original file line number
Diff line number
Diff line change
@@ -51,9 +51,13 @@ properties:
51
51
$ref: '#/$defs/error'
52
52
description: The workflow's reusable errors.
53
53
extensions:
54
-
type: object
55
-
additionalProperties:
56
-
$ref: '#/$defs/extension'
54
+
type: array
55
+
items:
56
+
type: object
57
+
minProperties: 1
58
+
maxProperties: 1
59
+
additionalProperties:
60
+
$ref: '#/$defs/extension'
57
61
description: The workflow's extensions.
58
62
functions:
59
63
type: object
@@ -72,11 +76,8 @@ properties:
72
76
description: The workflow's secrets.
73
77
description: Defines the workflow's reusable components.
74
78
do:
75
-
type: object
76
-
minProperties: 1
77
-
additionalProperties:
78
-
$ref: '#/$defs/task'
79
-
description: Defines the tasks the workflow must perform
79
+
description: Defines the task the workflow must perform
80
+
$ref: '#/$defs/task'
80
81
timeout:
81
82
$ref: '#/$defs/timeout'
82
83
description: The workflow's timeout configuration, if any.
@@ -109,6 +110,9 @@ $defs:
109
110
output:
110
111
$ref: '#/$defs/output'
111
112
description: Configure the task's output.
113
+
export:
114
+
$ref: '#/$defs/export'
115
+
description: Export task output to context.
112
116
timeout:
113
117
$ref: '#/$defs/timeout'
114
118
description: The task's timeout configuration, if any.
@@ -133,7 +137,7 @@ $defs:
133
137
- properties:
134
138
call:
135
139
type: string
136
-
constant: asyncapi
140
+
const: asyncapi
137
141
with:
138
142
type: object
139
143
properties:
@@ -156,15 +160,17 @@ $defs:
156
160
type: object
157
161
description: The payload to call the AsyncAPI operation with, if any.
158
162
authentication:
159
-
ref: '#/$defs/authenticationPolicy'
160
163
description: The authentication policy, if any, to use when calling the AsyncAPI operation.
164
+
oneOf:
165
+
- $ref: '#/$defs/authenticationPolicy'
166
+
- type: string
161
167
required: [ document, operationRef ]
162
168
description: Defines the AsyncAPI call to perform.
163
169
required: [ call, with ]
164
170
- properties:
165
171
call:
166
172
type: string
167
-
constant: grpc
173
+
const: grpc
168
174
with:
169
175
type: object
170
176
properties:
@@ -187,8 +193,10 @@ $defs:
187
193
max: 65535
188
194
description: The port number of the GRPC service to call.
189
195
authentication:
190
-
$ref: '#/$defs/authenticationPolicy'
191
196
description: The endpoint's authentication policy, if any.
197
+
oneOf:
198
+
- $ref: '#/$defs/authenticationPolicy'
199
+
- type: string
192
200
required: [ name, host ]
193
201
method:
194
202
type: string
@@ -203,16 +211,19 @@ $defs:
203
211
- properties:
204
212
call:
205
213
type: string
206
-
constant: http
214
+
const: http
207
215
with:
208
216
type: object
209
217
properties:
210
218
method:
211
219
type: string
212
220
description: The HTTP method of the HTTP request to perform.
213
221
endpoint:
214
-
$ref: '#/$defs/endpoint'
215
222
description: The HTTP endpoint to send the request to.
223
+
oneOf:
224
+
- $ref: '#/$defs/endpoint'
225
+
- type: string
226
+
format: uri-template
216
227
headers:
217
228
type: object
218
229
description: A name/value mapping of the headers, if any, of the HTTP request to perform.
@@ -228,7 +239,7 @@ $defs:
228
239
- properties:
229
240
call:
230
241
type: string
231
-
constant: openapi
242
+
const: openapi
232
243
with:
233
244
type: object
234
245
properties:
@@ -243,8 +254,10 @@ $defs:
243
254
additionalProperties: true
244
255
description: A name/value mapping of the parameters of the OpenAPI operation to call.
245
256
authentication:
246
-
$ref: '#/$defs/authenticationPolicy'
247
257
description: The authentication policy, if any, to use when calling the OpenAPI operation.
258
+
oneOf:
259
+
- $ref: '#/$defs/authenticationPolicy'
260
+
- type: string
248
261
output:
249
262
type: string
250
263
enum: [ raw, content, response ]
@@ -264,33 +277,44 @@ $defs:
264
277
description: A name/value mapping of the parameters, if any, to call the function with.
265
278
required: [ call ]
266
279
compositeTask:
280
+
type: object
281
+
required: [ execute ]
282
+
description: Serves as a pivotal orchestrator within workflow systems, enabling the seamless integration and execution of multiple subtasks to accomplish complex operations
267
283
properties:
268
284
execute:
269
285
type: object
270
-
oneOf:
271
-
- properties:
272
-
concurrently:
273
-
type: object
274
-
minProperties: 2
275
-
additionalProperties:
276
-
$ref: '#/$defs/task'
277
-
description: A name/definition mapping of the tasks to perform concurrently.
278
-
compete:
279
-
type: boolean
280
-
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.
281
-
required: [ concurrently ]
282
-
- properties:
283
-
sequentially:
284
-
type: object
285
-
minProperties: 2
286
-
additionalProperties:
287
-
$ref: '#/$defs/task'
288
-
description: A name/definition mapping of the tasks to perform sequentially.
289
-
required: [ sequentially ]
290
286
description: Configures the task execution strategy to use
291
-
required: [ execute ]
292
-
description: Serves as a pivotal orchestrator within workflow systems, enabling the seamless integration and execution of multiple subtasks to accomplish complex operations
287
+
oneOf:
288
+
- required: [ concurrently ]
289
+
properties:
290
+
concurrently:
291
+
description: A list of the tasks to perform concurrently.
292
+
type: array
293
+
minItems: 2
294
+
items:
295
+
type: object
296
+
minProperties: 1
297
+
maxProperties: 1
298
+
additionalProperties:
299
+
$ref: '#/$defs/task'
300
+
compete:
301
+
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.
302
+
type: boolean
303
+
default: false
304
+
- required: [ sequentially ]
305
+
properties:
306
+
sequentially:
307
+
description: A list of the tasks to perform sequentially.
308
+
type: array
309
+
minItems: 2
310
+
items:
311
+
type: object
312
+
minProperties: 1
313
+
maxProperties: 1
314
+
additionalProperties:
315
+
$ref: '#/$defs/task'
293
316
emitTask:
317
+
type: object
294
318
properties:
295
319
emit:
296
320
type: object
@@ -332,6 +356,7 @@ $defs:
332
356
default: continue
333
357
- type: string
334
358
forTask:
359
+
type: object
335
360
properties:
336
361
for:
337
362
type: object
@@ -487,25 +512,32 @@ $defs:
487
512
type: object
488
513
properties:
489
514
switch:
490
-
type: object
491
-
minProperties: 1
492
-
additionalProperties:
515
+
type: array
516
+
minItems: 1
517
+
items:
493
518
type: object
494
-
properties:
495
-
when:
496
-
type: string
497
-
description: A runtime expression used to determine whether or not the case matches.
498
-
then:
499
-
$ref: '#/$defs/flowDirective'
500
-
description: The flow directive to execute when the case matches.
519
+
minProperties: 1
520
+
maxProperties: 1
521
+
additionalProperties:
522
+
type: object
523
+
properties:
524
+
name:
525
+
type: string
526
+
description: The case's name.
527
+
when:
528
+
type: string
529
+
description: A runtime expression used to determine whether or not the case matches.
530
+
then:
531
+
$ref: '#/$defs/flowDirective'
532
+
description: The flow directive to execute when the case matches.
501
533
required: [ switch ]
502
534
description: Enables conditional branching within workflows, allowing them to dynamically select different paths based on specified conditions or criteria
503
535
tryTask:
504
536
type: object
505
537
properties:
506
538
try:
507
-
$ref: '#/$defs/task'
508
539
description: The task to perform.
540
+
$ref: '#/$defs/task'
509
541
catch:
510
542
type: object
511
543
properties:
@@ -524,8 +556,8 @@ $defs:
524
556
$ref: '#/$defs/retryPolicy'
525
557
description: The retry policy to use, if any, when catching errors.
526
558
do:
527
-
$ref: '#/$defs/task'
528
559
description: The definition of the task to run when catching an error.
560
+
$ref: '#/$defs/task'
529
561
required: [ try, catch ]
530
562
description: Serves as a mechanism within workflows to handle errors gracefully, potentially retrying failed tasks before proceeding with alternate ones.
531
563
waitTask:
@@ -665,11 +697,13 @@ $defs:
665
697
properties:
666
698
uri:
667
699
type: string
668
-
format: uri
700
+
format: uri-template
669
701
description: The endpoint's URI.
670
702
authentication:
671
-
$ref: '#/$defs/authenticationPolicy'
672
703
description: The authentication policy to use.
704
+
oneOf:
705
+
- $ref: '#/$defs/authenticationPolicy'
706
+
- type: string
673
707
required: [ uri ]
674
708
eventConsumptionStrategy:
675
709
type: object
@@ -746,11 +780,11 @@ $defs:
746
780
type: string
747
781
description: A runtime expression, if any, used to determine whether or not the extension should apply in the specified context.
748
782
before:
749
-
$ref: '#/$defs/task'
750
783
description: The task to execute before the extended task, if any.
751
-
after:
752
784
$ref: '#/$defs/task'
785
+
after:
753
786
description: The task to execute after the extended task, if any.
787
+
$ref: '#/$defs/task'
754
788
required: [ extend ]
755
789
description: The definition of a an extension.
756
790
externalResource:
@@ -761,8 +795,10 @@ $defs:
761
795
format: uri
762
796
description: The endpoint's URI.
763
797
authentication:
764
-
$ref: '#/$defs/authenticationPolicy'
765
798
description: The authentication policy to use.
799
+
oneOf:
800
+
- $ref: '#/$defs/authenticationPolicy'
801
+
- type: string
766
802
name:
767
803
type: string
768
804
description: The external resource's name, if any.
@@ -783,13 +819,20 @@ $defs:
783
819
schema:
784
820
$ref: '#/$defs/schema'
785
821
description: The schema used to describe and validate the output of the workflow or task.
786
-
from:
822
+
as:
787
823
type: string
788
824
description: A runtime expression, if any, used to mutate and/or filter the output of the workflow or task.
789
-
to:
790
-
type: string
791
-
description: A runtime expression, if any, used to output data to the current context.
792
825
description: Configures the output of a workflow or task.
826
+
export:
827
+
type: object
828
+
properties:
829
+
schema:
830
+
$ref: '#/$defs/schema'
831
+
description: The schema used to describe and validate the workflow context.
832
+
as:
833
+
type: string
834
+
description: A runtime expression, if any, used to export the output data to the context.
0 commit comments