Skip to content

Commit fc0369f

Browse files
authored
Merge branch 'main' into yuri-dsl-doc-update
2 parents 67ac33c + 7654925 commit fc0369f

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

schema/workflow.yaml

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ properties:
103103
description: Schedules the workflow
104104
$defs:
105105
taskList:
106+
title: TaskList
106107
type: array
107108
items:
108109
type: object
@@ -214,8 +215,8 @@ $defs:
214215
description: The hostname of the GRPC service to call.
215216
port:
216217
type: integer
217-
min: 0
218-
max: 65535
218+
minimum: 0
219+
maximum: 65535
219220
description: The port number of the GRPC service to call.
220221
authentication:
221222
$ref: '#/$defs/referenceableAuthenticationPolicy'
@@ -314,6 +315,7 @@ $defs:
314315
additionalProperties: true
315316
description: A name/value mapping of the parameters, if any, to call the function with.
316317
forkTask:
318+
title: ForkTask
317319
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.
318320
$ref: '#/$defs/taskBase'
319321
type: object
@@ -331,6 +333,7 @@ $defs:
331333
type: boolean
332334
default: false
333335
doTask:
336+
title: DoTask
334337
description: Allows to execute a list of tasks in sequence
335338
$ref: '#/$defs/taskBase'
336339
type: object
@@ -340,6 +343,7 @@ $defs:
340343
do:
341344
$ref: '#/$defs/taskList'
342345
emitTask:
346+
title: EmitTask
343347
description: Allows workflows to publish events to event brokers or messaging systems, facilitating communication and coordination between different components and services.
344348
$ref: '#/$defs/taskBase'
345349
type: object
@@ -377,6 +381,7 @@ $defs:
377381
additionalProperties: true
378382
required: [ event ]
379383
forTask:
384+
title: ForTask
380385
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.
381386
$ref: '#/$defs/taskBase'
382387
type: object
@@ -404,6 +409,7 @@ $defs:
404409
do:
405410
$ref: '#/$defs/taskList'
406411
listenTask:
412+
title: ListenTask
407413
description: Provides a mechanism for workflows to await and react to external events, enabling event-driven behavior within workflow systems.
408414
$ref: '#/$defs/taskBase'
409415
type: object
@@ -418,6 +424,7 @@ $defs:
418424
description: Defines the event(s) to listen to.
419425
required: [ to ]
420426
raiseTask:
427+
title: RaiseTask
421428
description: Intentionally triggers and propagates errors.
422429
$ref: '#/$defs/taskBase'
423430
type: object
@@ -432,6 +439,7 @@ $defs:
432439
description: Defines the error to raise.
433440
required: [ error ]
434441
runTask:
442+
title: RunTask
435443
description: Provides the capability to execute external containers, shell commands, scripts, or workflows.
436444
$ref: '#/$defs/taskBase'
437445
type: object
@@ -540,6 +548,7 @@ $defs:
540548
required: [ workflow ]
541549
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.
542550
setTask:
551+
title: SetTask
543552
description: A task used to set data
544553
$ref: '#/$defs/taskBase'
545554
type: object
@@ -552,6 +561,7 @@ $defs:
552561
additionalProperties: true
553562
description: The data to set
554563
switchTask:
564+
title: SwitchTask
555565
description: Enables conditional branching within workflows, allowing them to dynamically select different paths based on specified conditions or criteria
556566
$ref: '#/$defs/taskBase'
557567
type: object
@@ -569,17 +579,17 @@ $defs:
569579
additionalProperties:
570580
type: object
571581
title: SwitchCase
582+
required:
583+
- then
572584
properties:
573-
name:
574-
type: string
575-
description: The case's name.
576585
when:
577586
type: string
578587
description: A runtime expression used to determine whether or not the case matches.
579588
then:
580589
$ref: '#/$defs/flowDirective'
581590
description: The flow directive to execute when the case matches.
582591
tryTask:
592+
title: TryTask
583593
description: Serves as a mechanism within workflows to handle errors gracefully, potentially retrying failed tasks before proceeding with alternate ones.
584594
$ref: '#/$defs/taskBase'
585595
type: object
@@ -611,6 +621,7 @@ $defs:
611621
description: The definition of the task(s) to run when catching an error.
612622
$ref: '#/$defs/taskList'
613623
waitTask:
624+
title: WaitTask
614625
description: Allows workflows to pause or delay their execution for a specified period of time.
615626
$ref: '#/$defs/taskBase'
616627
type: object
@@ -621,7 +632,6 @@ $defs:
621632
description: The amount of time to wait.
622633
$ref: '#/$defs/duration'
623634
flowDirective:
624-
additionalProperties: false
625635
anyOf:
626636
- type: string
627637
enum: [ continue, exit, end ]

0 commit comments

Comments
 (0)