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
+17-16Lines changed: 17 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1762,8 +1762,8 @@ definition "id" must be a constant value.
1762
1762
1763
1763
| Parameter | Description | Type | Required |
1764
1764
| --- | --- | --- | --- |
1765
-
| id | Workflow unique identifier | string | yes if `key` not defined |
1766
-
| key | Domain-specific workflow identifier | string | yes if `id` not defined |
1765
+
| id | Workflow unique identifier | string | yes (if `key` is not defined) |
1766
+
| key | Domain-specific workflow identifier | string | yes (if `id` is not defined) |
1767
1767
| name | Workflow name | string | no |
1768
1768
| description | Workflow description | string | no |
1769
1769
| version | Workflow version. MUST respect the [semantic versioning](https://semver.org/) format | string | no |
@@ -2353,7 +2353,8 @@ the [Workflow Timeouts](#Workflow-Timeouts) section.
2353
2353
| --- | --- | --- | --- |
2354
2354
| name | Unique State name | string | yes |
2355
2355
| type | State type | string | yes |
2356
-
| [dataConditions](#Switch-state-Data-Conditions) or [eventConditions](#Switch-State-Event-Conditions) | Defined if the Switch state evaluates conditions and transitions based on state data, or arrival of events. | array | yes (one) |
2356
+
| [dataConditions](#Switch-state-Data-Conditions) | Defined if the Switch state evaluates conditions and transitions based on state data. | array | yes (if `eventConditions` is not defined) |
2357
+
| [eventConditions](#Switch-State-Event-Conditions) | Defined if the Switch state evaluates conditions and transitions based on arrival of events. | array | yes (if `dataConditions` is not defined |
2357
2358
| [stateDataFilter](#State-data-filters) | State data filter | object | no |
2358
2359
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
2359
2360
| [timeouts](#Workflow-Timeouts) | State specific timeout settings | object | no |
@@ -2504,7 +2505,7 @@ Note that `transition` and `end` properties are mutually exclusive, meaning that
2504
2505
| type | State type | string | yes |
2505
2506
| [branches](#Parallel-State-Branch) | List of branches for this parallel state| array | yes |
2506
2507
| completionType | Option types on how to complete branch execution. Default is "allOf" | enum | no |
2507
-
| numCompleted | Used when branchCompletionType is set to `atLeast` to specify the least number of branches that must complete in order for the state to transition/end. | string or number | yes (if completionType is `atLeast`) |
2508
+
| numCompleted | Used when branchCompletionType is set to `atLeast` to specify the least number of branches that must complete in order for the state to transition/end. | string or number | yes (if `completionType` is `atLeast`) |
2508
2509
| [timeouts](#Workflow-Timeouts) | State specific timeout settings | object | no |
2509
2510
| [stateDataFilter](#State-data-filters) | State data filter | object | no |
2510
2511
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
@@ -3320,8 +3321,8 @@ It's worth noting that if an [auth definition](#Auth-Definition) has been define
3320
3321
| Parameter | Description | Type | Required |
3321
3322
| --- | --- | --- | --- |
3322
3323
| name | Unique event name | string | yes |
3323
-
| source | CloudEvent source | string | no if `type` is set, otherwise yes. If not set when `kind` is `produced`, runtimes are expected to use a default value, such as https://serverlessworkflow.io in order to comply with the [CloudEvent spec constraints](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) |
3324
-
| type | CloudEvent type | string | no if `source` is set, otherwise yes |
3324
+
| source | CloudEvent source. If not set when `kind` is `produced`, runtimes are expected to use a default value, such as https://serverlessworkflow.io in order to comply with the [CloudEvent spec constraints](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1))| string | yes (if `type` is not defined. |
3325
+
| type | CloudEvent type | string | yes (if `source` is not defined) |
3325
3326
| kind | Defines the event is either `consumed` or `produced` by the workflow. Default is `consumed` | enum | no |
3326
3327
| [correlation](#Correlation-Definition) | Define event correlation rules for this event. Only used for consumed events | array | no |
3327
3328
| dataOnly | If `true` (default value), only the Event payload is accessible to consuming Workflow states. If `false`, both event payload and context attributes should be accessible | boolean | no |
@@ -3538,7 +3539,7 @@ It can be used for both the retrieval of the function's resource (as defined by
3538
3539
| Parameter | Description | Type | Required |
3539
3540
| --- | --- | --- | --- |
3540
3541
| name | Unique auth definition name | string | yes |
3541
-
| scheme | Auth scheme, can be "basic", "bearer", or "oauth2". Default is "basic" | enum | yes |
3542
+
| scheme | Auth scheme, can be "basic", "bearer", or "oauth2". Default is "basic" | enum | no |
3542
3543
| properties | Auth scheme properties. Can be one of ["Basic properties definition"](#basic-properties-definition), ["Bearer properties definition"](#bearer-properties-definition), or ["OAuth2 properties definition"](#oauth2-properties-definition) | object | yes |
3543
3544
3544
3545
The `name` property defines the unique auth definition name.
@@ -3593,7 +3594,7 @@ See [here](https://oauth.net/2/) for more information about OAuth2 Authenticatio
| contextAttributeValue | CloudEvent Extension Context Attribute name | string | no |
3597
+
| contextAttributeValue | CloudEvent Extension Context Attribute value | string | no |
3597
3598
3598
3599
<details><summary><strong>Click to view example definition</strong></summary>
3599
3600
<p>
@@ -3748,9 +3749,9 @@ This is visualized in the diagram below:
3748
3749
| Parameter | Description | Type | Required |
3749
3750
| --- | --- | --- | --- |
3750
3751
| name | Unique Action name | string | no |
3751
-
| [functionRef](#FunctionRef-Definition) | References a reusable function definition | object or string | yes if `eventRef` & `subFlowRef` are not defined |
3752
-
| [eventRef](#EventRef-Definition) | References a `produce` and `consume` reusable event definitions | object | yes if `functionRef` & `subFlowRef` are not defined |
3753
-
| [subFlowRef](#SubFlowRef-Definition) | References a workflow to be invoked | object or string | yes if `eventRef` & `functionRef` are not defined |
3752
+
| [functionRef](#FunctionRef-Definition) | References a reusable function definition | object or string | yes (if `eventRef` & `subFlowRef` are not defined) |
3753
+
| [eventRef](#EventRef-Definition) | References a `produce` and `consume` reusable event definitions | object | yes (if `functionRef` & `subFlowRef` are not defined) |
3754
+
| [subFlowRef](#SubFlowRef-Definition) | References a workflow to be invoked | object or string | yes (if `eventRef` & `functionRef` are not defined) |
3754
3755
| [retryRef](#retry-definition) | References a defined workflow retry definition. If not defined uses the default runtime retry definition | string | no |
3755
3756
| nonRetryableErrors | List of references to defined [workflow errors](#Defining-Errors) for which the action should not be retried. Used only when `autoRetries` is set to `true` | array | no |
3756
3757
| retryableErrors | List of references to defined [workflow errors](#Defining-Errors) for which the action should be retried. Used only when `autoRetries` is set to `false` | array | no |
@@ -3875,8 +3876,8 @@ it with its `object` type which has the following properties:
3875
3876
| Parameter | Description | Type | Required |
3876
3877
| --- | --- | --- | --- |
3877
3878
| refName | Name of the referenced [function](#Function-Definition) | string | yes |
3878
-
| arguments | Arguments (inputs) to be passed to the referenced function | object | yes if function type is `graphql`, otherwise no |
3879
-
| selectionSet | Used if function type is `graphql`. String containing a valid GraphQL [selection set](https://spec.graphql.org/June2018/#sec-Selection-Sets) | string | yes if function type is `graphql`, otherwise no |
3879
+
| arguments | Arguments (inputs) to be passed to the referenced function | object | yes (if function type is `graphql`, otherwise no) |
3880
+
| selectionSet | Used if function type is `graphql`. String containing a valid GraphQL [selection set](https://spec.graphql.org/June2018/#sec-Selection-Sets) | string | yes (if function type is `graphql`, otherwise no) |
3880
3881
| invoke | Specifies if the function should be invoked `sync` or `async`. Default is `sync` | enum | no |
3881
3882
3882
3883
<details><summary><strong>Click to view example definition</strong></summary>
@@ -4157,7 +4158,7 @@ For more information, see the [Workflow Error Handling](#Workflow-Error-Handling
4157
4158
| --- | --- | --- | --- |
4158
4159
| name | Unique retry strategy name | string | yes |
4159
4160
| delay | Time delay between retry attempts (ISO 8601 duration format) | string | no |
4160
-
| maxAttempts | Maximum number of retry attempts. Value of 1 means no retries are performed | string or number | no |
4161
+
| maxAttempts | Maximum number of retry attempts. Value of 1 means no retries are performed | string or number | yes |
4161
4162
| maxDelay | Maximum amount of delay between retry attempts (ISO 8601 duration format) | string | no |
4162
4163
| increment | Static duration which will be added to the delay between successive retries (ISO 8601 duration format) | string | no |
4163
4164
| multiplier | Float value by which the delay is multiplied before each attempt. For example: "1.2"meaning that each successive delay is 20% longer than the previous delay. For example, if delay is 'PT10S', then the delay between the first and second attempts will be 10 seconds, and the delay before the third attempt will be 12 seconds. | float or string | no |
@@ -4665,8 +4666,8 @@ it with its `object` type which has the following properties:
4665
4666
4666
4667
| Parameter | Description | Type | Required |
4667
4668
| --- | --- | --- | --- |
4668
-
| interval | A recurring time interval expressed in the derivative of ISO 8601 format specified below. Declares that workflow instances should be automatically created at the start of each time interval in the series. | string | yes if `cron` not defined |
4669
-
| [cron](#Cron-Definition) | Cron expression defining when workflow instances should be automatically created | object | yes if `interval` not defined |
4669
+
| interval | A recurring time interval expressed in the derivative of ISO 8601 format specified below. Declares that workflow instances should be automatically created at the start of each time interval in the series. | string | yes (if `cron` is not defined) |
4670
+
| [cron](#Cron-Definition) | Cron expression defining when workflow instances should be automatically created | object | yes (if `interval` is not defined) |
4670
4671
| timezone | Timezone name used to evaluate the interval & cron-expression. If the interval specifies a date-time w/ timezone then proper timezone conversion will be applied. (default: UTC). | string | no |
4671
4672
4672
4673
<details><summary><strong>Click to view example definition</strong></summary>
0 commit comments