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
Copy file name to clipboardExpand all lines: specification.md
+20-17Lines changed: 20 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2134,9 +2134,9 @@ Serverless Workflow defines the following Workflow States:
2134
2134
| [onEvents](#OnEvents-Definition) | Define the events to be consumed and optional actions to be performed | array | yes |
2135
2135
| [timeouts](#Workflow-Timeouts) | State specific timeout settings | object | no |
2136
2136
| [stateDataFilter](#State-data-filters) | State data filter definition| object | no |
2137
-
| [transition](#Transitions) | Next transition of the workflow after all the actions have been performed | object | yes if "end" is not defined |
2137
+
| [transition](#Transitions) | Next transition of the workflow after all the actions have been performed | string or object | yes (if `end` is not defined) |
2138
2138
| [onErrors](#Error-Definition) | States error handling definitions | array | no |
2139
-
| [end](#End-Definition) | Is this state an end state | object | yes, if "transition" is not defined |
2139
+
| [end](#End-Definition) | Is this state an end state | boolean or object | yes (if `transition` is not defined) |
2140
2140
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | string | no |
2141
2141
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
2142
2142
@@ -2283,11 +2283,11 @@ Note that `transition` and `end` properties are mutually exclusive, meaning that
2283
2283
| [timeouts](#Workflow-Timeouts) | State specific timeout settings | object | no |
2284
2284
| [stateDataFilter](#State-data-filters) | State data filter | object | no |
2285
2285
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
2286
-
| [transition](#Transitions) | Next transition of the workflow after all the actions have been performed | object | yes (if end is not defined) |
2286
+
| [transition](#Transitions) | Next transition of the workflow after all the actions have been performed | string or object | yes (if `end` is not defined) |
2287
2287
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | string | no |
2288
2288
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
2289
2289
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
2290
-
| [end](#End-Definition) | Is this state an end state | object | no |
2290
+
| [end](#End-Definition) | Is this state an end state | boolean or object | yes (if `transition` is not defined) |
2291
2291
2292
2292
<details><summary><strong>Click to view example definition</strong></summary>
2293
2293
<p>
@@ -2452,8 +2452,8 @@ The `timeouts` property can be used to define state specific timeout settings. S
2452
2452
| name | Unique State name | string | yes |
2453
2453
| type | State type | string | yes |
2454
2454
| duration | Duration (ISO 8601 duration format) to sleep. For example: "PT15M"(sleep 15 minutes), or "P2DT3H4M" (sleep 2 days, 3 hours and 4 minutes) | string | yes |
2455
-
| [transition](#Transitions) | Next transition of the workflow after the sleep | object | yes (if end is not defined) |
2456
-
| [end](#End-Definition) |If this state an end state | object | no |
2455
+
| [transition](#Transitions) | Next transition of the workflow after the sleep | string or object | yes (if `end` is not defined) |
2456
+
| [end](#End-Definition) | Is this state an end state | boolean or object | yes (if `transition` is not defined) |
2457
2457
2458
2458
<details><summary><strong>Click to view example definition</strong></summary>
2459
2459
<p>
@@ -2508,11 +2508,11 @@ Note that `transition` and `end` properties are mutually exclusive, meaning that
2508
2508
| [timeouts](#Workflow-Timeouts) | State specific timeout settings | object | no |
2509
2509
| [stateDataFilter](#State-data-filters) | State data filter | object | no |
2510
2510
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
2511
-
| [transition](#Transitions) | Next transition of the workflow after all branches have completed execution | object | yes if "end" is not defined |
2511
+
| [transition](#Transitions) | Next transition of the workflow after all branches have completed execution | string or object | yes (if `end` is not defined) |
2512
2512
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | string | no |
2513
2513
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
2514
2514
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
2515
-
| [end](#End-Definition) | If this state and end state | object | yes if "transition" is not defined |
2515
+
| [end](#End-Definition) | Is this state an end state | boolean or object | yes (if `transition` is not defined) |
2516
2516
2517
2517
<details><summary><strong>Click to view example definition</strong></summary>
2518
2518
<p>
@@ -2618,11 +2618,11 @@ Note that `transition` and `end` properties are mutually exclusive, meaning that
2618
2618
| type | State type | string | yes |
2619
2619
| data | JSON object which can be set as state's data input and can be manipulated via filter | object | yes |
2620
2620
| [stateDataFilter](#state-data-filters) | State data filter | object | no |
2621
-
| [transition](#Transitions) | Next transition of the workflow after injection has completed | object | yes if "end" is set to false |
2621
+
| [transition](#Transitions) | Next transition of the workflow after injection has completed | string or object | yes (if `end` is not defined) |
2622
2622
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | string | no |
2623
2623
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
2624
2624
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
2625
-
| [end](#End-Definition) | If this state and end state | object | yes if "transition" is not defined |
2625
+
| [end](#End-Definition) | Is this state an end state | boolean or object | yes (if `transition` is not defined) |
2626
2626
2627
2627
<details><summary><strong>Click to view example definition</strong></summary>
2628
2628
<p>
@@ -2855,11 +2855,11 @@ Note that `transition` and `end` properties are mutually exclusive, meaning that
2855
2855
| [timeouts](#Workflow-Timeouts) | State specific timeout settings | object | no |
2856
2856
| [stateDataFilter](#State-data-filters) | State data filter definition | object | no |
2857
2857
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
2858
-
| [transition](#Transitions) | Next transition of the workflow after state has completed | object | yes if "end" is not defined |
2858
+
| [transition](#Transitions) | Next transition of the workflow after state has completed | string or object | yes (if `end` is not defined) |
2859
2859
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | string | no |
2860
2860
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
2861
2861
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
2862
-
| [end](#End-Definition) | Is this state an end state | object | yes if "transition" is not defined |
2862
+
| [end](#End-Definition) | Is this state an end state | boolean or object | yes (if `transition` is not defined) |
2863
2863
2864
2864
<details><summary><strong>Click to view example definition</strong></summary>
2865
2865
<p>
@@ -3095,8 +3095,8 @@ Note that `transition` and `end` properties are mutually exclusive, meaning that
3095
3095
| [eventDataFilter](#Event-data-filters) | Callback event data filter definition | object | no |
3096
3096
| [stateDataFilter](#State-data-filters) | State data filter definition | object | no |
3097
3097
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
3098
-
| [transition](#Transitions) | Next transition of the workflow after callback event has been received | object | yes if "end" is not defined |
3099
-
| [end](#End-Definition) | Is this state an end state | object | yes if "transition" is not defined |
3098
+
| [transition](#Transitions) | Next transition of the workflow after callback event has been received | string or object | yes (if `end` is not defined) |
3099
+
| [end](#End-Definition) | Is this state an end state | boolean or object | yes (if `transition` is not defined) |
3100
3100
| [compensatedBy](#Workflow-Compensation) | Uniaue name of a workflow state which is responsible for compensation of this state | string | no |
3101
3101
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
3102
3102
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
@@ -4093,7 +4093,8 @@ If it is set to `continue`, if the parent workflow completes, the subflow execut
4093
4093
| Parameter | Description | Type | Required |
4094
4094
| --- | --- | --- | --- |
4095
4095
| errorRef or errorRefs | Reference one unique workflow error definition, or multiple unique workflow error definitions | string (errorRef) or array (errorRefs) | yes |
4096
-
| [transition](#Transitions) or [end](#End-Definition) | Transition to next state to handle the error, or end workflow execution if this error is encountered | object | yes |
4096
+
| [transition](#Transitions) | Transition to next state to handle the error | string or object | yes (if `end` is not defined) |
4097
+
| [end](#End-Definition) | End workflow execution if this error is encountered | boolean or object | yes (if `transition` is not defined) |
4097
4098
4098
4099
<details><summary><strong>Click to view example definition</strong></summary>
4099
4100
<p>
@@ -4351,7 +4352,8 @@ Transitions allow you to move from one state (control-logic block) to another. F
4351
4352
| --- | --- | --- | --- |
4352
4353
| name | Data condition name | string | no |
4353
4354
| [condition](#Workflow-Expressions) | Workflow expression evaluated against state data. Must evaluate to true or false | string | yes |
4354
-
| [transition](#Transitions) or [end](#End-Definition) | Defines what to do if condition is true. Transition to another state, or end workflow | object | yes |
4355
+
| [transition](#Transitions) | Transition to another state if condition is true | string or object | yes (if `end` is not defined) |
4356
+
| [end](#End-Definition) | End workflow execution if condition is true | boolean or object | yes (if `transition` is not defined) |
4355
4357
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
4356
4358
4357
4359
<details><summary><strong>Click to view example definition</strong></summary>
@@ -4403,7 +4405,8 @@ definitions are mutually exclusive, meaning that you can specify either one or t
4403
4405
| --- | --- | --- | --- |
4404
4406
| name | Event condition name | string | no |
4405
4407
| eventRef | References an unique event name in the defined workflow events | string | yes |
4406
-
| [transition](#Transitions) or [end](#End-Definition) | Defines what to do if condition is true. Transition to another state, or end workflow | object | yes |
4408
+
| [transition](#Transitions) | Transition to another state if condition is true | string or object | yes (if `end` is not defined) |
4409
+
| [end](#End-Definition) | End workflow execution if condition is true | boolean or object | yes (if `transition` is not defined) |
4407
4410
| [eventDataFilter](#Event-data-filters) | Event data filter definition | object | no |
4408
4411
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
0 commit comments