Skip to content

Commit 98c28aa

Browse files
authored
Merge pull request #636 from hbelmiro/spec-fixes
Minor fixes in the spec
2 parents a00cd67 + 6dde2bd commit 98c28aa

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

specification.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2279,7 +2279,7 @@ Note that `transition` and `end` properties are mutually exclusive, meaning that
22792279
| --- | --- | --- | --- |
22802280
| name | Unique State name | string | yes |
22812281
| type | State type | string | yes |
2282-
| actionMode | Should actions be performed sequentially or in parallel | string | no |
2282+
| actionMode | Should actions be performed sequentially or in parallel | enum | no |
22832283
| [actions](#Action-Definition) | Actions to be performed | array | yes |
22842284
| [timeouts](#Workflow-Timeouts) | State specific timeout settings | object | no |
22852285
| [stateDataFilter](#State-data-filters) | State data filter | object | no |
@@ -2851,7 +2851,7 @@ Note that `transition` and `end` properties are mutually exclusive, meaning that
28512851
| outputCollection | Workflow expression specifying an array element of the states data to add the results of each iteration | string | no |
28522852
| iterationParam | Name of the iteration parameter that can be referenced in actions/workflow. For each parallel iteration, this param should contain an unique element of the inputCollection array | string | no |
28532853
| batchSize | Specifies how many iterations may run in parallel at the same time. Used if `mode` property is set to `parallel` (default). If not specified, its value should be the size of the `inputCollection` | string or number | no |
2854-
| mode | Specifies how iterations are to be performed (sequentially or in parallel). Default is `parallel` | string | no |
2854+
| mode | Specifies how iterations are to be performed (sequentially or in parallel). Default is `parallel` | enum | no |
28552855
| [actions](#Action-Definition) | Actions to be executed for each of the elements of inputCollection | array | yes |
28562856
| [timeouts](#Workflow-Timeouts) | State specific timeout settings | object | no |
28572857
| [stateDataFilter](#State-data-filters) | State data filter definition | object | no |
@@ -3599,7 +3599,7 @@ The `contextAttributeValue` property defines the value of the defined CloudEvent
35993599
| Parameter | Description | Type | Required |
36003600
| --- | --- | --- | --- |
36013601
| eventRefs | References one or more unique event names in the defined workflow [events](#Event-Definition) | array | yes |
3602-
| actionMode | Specifies how actions are to be performed (in sequence or in parallel). Default is "sequential" | string | no |
3602+
| actionMode | Specifies how actions are to be performed (in sequence or in parallel). Default is `sequential` | enum | no |
36033603
| [actions](#Action-Definition) | Actions to be performed | array | no |
36043604
| [eventDataFilter](#Event-data-filters) | Event data filter definition | object | no |
36053605

@@ -3705,8 +3705,8 @@ This is visualized in the diagram below:
37053705
| [eventRef](#EventRef-Definition) | References a `produce` and `consume` reusable event definitions | object | yes if `functionRef` & `subFlowRef` are not defined |
37063706
| [subFlowRef](#SubFlowRef-Definition) | References a workflow to be invoked | object or string | yes if `eventRef` & `functionRef` are not defined |
37073707
| [retryRef](#retry-definition) | References a defined workflow retry definition. If not defined uses the default runtime retry definition | string | no |
3708-
| 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 |
3709-
| 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 |
3708+
| 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 |
3709+
| 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 |
37103710
| [actionDataFilter](#Action-data-filters) | Action data filter definition | object | no |
37113711
| sleep | Defines time periods workflow execution should sleep before / after function execution | object | no |
37123712
| [condition](#Workflow-Expressions) | Expression, if defined, must evaluate to true for this action to be performed. If false, action is disregarded | boolean | no |
@@ -3830,7 +3830,7 @@ it with its `object` type which has the following properties:
38303830
| refName | Name of the referenced [function](#Function-Definition) | string | yes |
38313831
| arguments | Arguments (inputs) to be passed to the referenced function | object | yes if function type is `graphql`, otherwise no |
38323832
| 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 |
3833-
| invoke | Specifies if the function should be invoked sync or async. Default is sync | string | no |
3833+
| invoke | Specifies if the function should be invoked `sync` or `async`. Default is `sync` | enum | no |
38343834

38353835
<details><summary><strong>Click to view example definition</strong></summary>
38363836
<p>
@@ -3905,7 +3905,7 @@ Allows defining invocation of a function via event.
39053905
| consumeEventTimeout | Maximum amount of time (ISO 8601 format) to wait for the consume event. If not defined it be set to the [actionExecutionTimeout](#Workflow-Timeout-Definition) | string | no |
39063906
| data | If string type, an expression which selects parts of the states data output to become the data (payload) of the event referenced by `produceEventRef`. If object type, a custom object to become the data (payload) of the event referenced by `produceEventRef`. | string or object | no |
39073907
| contextAttributes | Add additional event extension context attributes to the trigger/produced event | object | no |
3908-
| invoke | Specifies if the function should be invoked sync or async. Default is sync | string | no |
3908+
| invoke | Specifies if the function should be invoked sync or async. Default is sync | enum | no |
39093909

39103910
<details><summary><strong>Click to view example definition</strong></summary>
39113911
<p>
@@ -3984,8 +3984,8 @@ If you need to define the `version` properties, you can use its `object` type:
39843984
| --- | --- | --- | --- |
39853985
| workflowId | Sub-workflow unique id | string | yes |
39863986
| version | Sub-workflow version | string | no |
3987-
| invoke | Specifies if the subflow should be invoked sync or async. Default is sync | string | no |
3988-
| onParentComplete | If invoke is 'async', specifies how subflow execution should behave when parent workflow completes. Default is 'terminate' | string | no |
3987+
| invoke | Specifies if the subflow should be invoked `sync` or `async`. Default is `sync` | enum | no |
3988+
| onParentComplete | If `invoke` is `async`, specifies if subflow execution should `terminate` or `continue` when parent workflow completes. Default is `terminate` | enum | no |
39893989

39903990
<details><summary><strong>Click to view example definition</strong></summary>
39913991
<p>

0 commit comments

Comments
 (0)