Skip to content

Add clarification on mutually exclusive properties #566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tsurdilo merged 2 commits into from
Dec 25, 2021
Merged

Add clarification on mutually exclusive properties #566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
931cb3b
Add clarification on mutually exclusive properties
tsurdilo Dec 23, 2021
6f81c32
fixing errors
tsurdilo Dec 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions roadmap/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ _Status description:_
| ✔️| Fix support for workflow extensions | [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md) |
| ✔️| Fix state execution timeout | [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md) |
| ✔️| Update rules of retries increment and multiplier properties | [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md) |
| ✔️| Add clarification on mutually exclusive properties | [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md) |
| ✏️️| Add inline state defs in branches | |
| ✏️️| Update rest function definition | |
| ✏️️| Add "completedBy" functionality | |
Expand Down
47 changes: 33 additions & 14 deletions specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2175,9 +2175,9 @@ Serverless Workflow defines the following Workflow States:
| [onEvents](#OnEvents-Definition) | Define the events to be consumed and optional actions to be performed | array | yes |
| [timeouts](#Workflow-Timeouts) | State specific timeout settings | object | no |
| [stateDataFilter](#State-data-filters) | State data filter definition| object | no |
| [transition](#Transitions) | Next transition of the workflow after all the actions have been performed | object | yes |
| [transition](#Transitions) | Next transition of the workflow after all the actions have been performed | object | yes if "end" is not defined |
| [onErrors](#Error-Definition) | States error handling definitions | array | no |
| [end](#End-Definition) | Is this state an end state | object | no |
| [end](#End-Definition) | Is this state an end state | object | yes, if "transition" is not defined |
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | String | no |
| [metadata](#Workflow-Metadata) | Metadata information| object | no |

Expand Down Expand Up @@ -2311,6 +2311,8 @@ The `timeouts` property can be used to define state specific timeout settings. E
For more information about Event state specific event timeout settings reference [this section](#Event-Timeout-Definition).
For more information about workflow timeouts reference the [Workflow Timeouts](#Workflow-Timeouts) section.

Note that `transition` and `end` properties are mutually exclusive, meaning that you cannot define both of them at the same time.

##### Operation State

| Parameter | Description | Type | Required |
Expand Down Expand Up @@ -2534,6 +2536,7 @@ Sleep state
suspends workflow execution for a given time duration. The delay is defined in its `duration` property using the ISO 8601
duration format.

Note that `transition` and `end` properties are mutually exclusive, meaning that you cannot define both of them at the same time.
##### Parallel State

| Parameter | Description | Type | Required |
Expand All @@ -2547,11 +2550,11 @@ duration format.
| [timeouts](#Workflow-Timeouts) | State specific timeout settings | object | no |
| [stateDataFilter](#State-data-filters) | State data filter | object | no |
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
| [transition](#Transitions) | Next transition of the workflow after all branches have completed execution | object | yes (if end is not defined) |
| [transition](#Transitions) | Next transition of the workflow after all branches have completed execution | object | yes if "end" is not defined |
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | String | no |
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
| [end](#End-Definition) | If this state and end state | object | no |
| [end](#End-Definition) | If this state and end state | object | yes if "transition" is not defined |

<details><summary><strong>Click to view example definition</strong></summary>
<p>
Expand Down Expand Up @@ -2647,6 +2650,8 @@ The `timeouts` property can be used to set state specific timeout settings. Para
`stateExecTimeout` and `branchExecTimeout` timeout settings. For more information on workflow timeouts
reference the [Workflow Timeouts](#Workflow-Timeouts) section.

Note that `transition` and `end` properties are mutually exclusive, meaning that you cannot define both of them at the same time.

##### Inject State

| Parameter | Description | Type | Required |
Expand All @@ -2656,11 +2661,11 @@ reference the [Workflow Timeouts](#Workflow-Timeouts) section.
| type | State type | string | yes |
| data | JSON object which can be set as state's data input and can be manipulated via filter | object | yes |
| [stateDataFilter](#state-data-filters) | State data filter | object | no |
| [transition](#Transitions) | Next transition of the workflow after injection has completed | object | yes (if end is set to false) |
| [transition](#Transitions) | Next transition of the workflow after injection has completed | object | yes if "end" is set to false |
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | String | no |
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
| [end](#End-Definition) | If this state and end state | object | no |
| [end](#End-Definition) | If this state and end state | object | yes if "transition" is not defined |

<details><summary><strong>Click to view example definition</strong></summary>
<p>
Expand Down Expand Up @@ -2876,6 +2881,8 @@ The `timeouts` property can be used to define state specific timeout settings. I
`stateExecTimeout` property. For more information on workflow timeouts reference the
[Workflow Timeouts](#Workflow-Timeouts) section.

Note that `transition` and `end` properties are mutually exclusive, meaning that you cannot define both of them at the same time.

##### ForEach State

| Parameter | Description | Type | Required |
Expand All @@ -2892,11 +2899,11 @@ The `timeouts` property can be used to define state specific timeout settings. I
| [timeouts](#Workflow-Timeouts) | State specific timeout settings | object | no |
| [stateDataFilter](#State-data-filters) | State data filter definition | object | no |
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
| [transition](#Transitions) | Next transition of the workflow after state has completed | object | yes (if end is not defined) |
| [transition](#Transitions) | Next transition of the workflow after state has completed | object | yes if "end" is not defined |
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | String | no |
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
| [end](#End-Definition) | Is this state an end state | object | no |
| [end](#End-Definition) | Is this state an end state | object | yes if "transition" is not defined |

<details><summary><strong>Click to view example definition</strong></summary>
<p>
Expand Down Expand Up @@ -3118,6 +3125,8 @@ The `timeouts` property can be used to set state specific timeout settings. ForE
`stateExecTimeout` and `actionExecTimeout` settings. For more information on workflow timeouts reference the [Workflow Timeouts](#Workflow-Timeouts)
section.

Note that `transition` and `end` properties are mutually exclusive, meaning that you cannot define both of them at the same time.

##### Callback State

| Parameter | Description | Type | Required |
Expand All @@ -3131,8 +3140,8 @@ section.
| [eventDataFilter](#Event-data-filters) | Callback event data filter definition | object | no |
| [stateDataFilter](#State-data-filters) | State data filter definition | object | no |
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
| [transition](#Transitions) | Next transition of the workflow after callback event has been received | object | yes |
| [end](#End-Definition) | Is this state an end state | object | no |
| [transition](#Transitions) | Next transition of the workflow after callback event has been received | object | yes if "end" is not defined |
| [end](#End-Definition) | Is this state an end state | object | yes if "transition" is not defined |
| [compensatedBy](#Workflow-Compensation) | Uniaue name of a workflow state which is responsible for compensation of this state | String | no |
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
Expand Down Expand Up @@ -3216,6 +3225,8 @@ The `timeouts` property defines state specific timeout settings. Callback states
For more information on workflow timeouts reference the [Workflow Timeouts](#Workflow-Timeouts)
section.

Note that `transition` and `end` properties are mutually exclusive, meaning that you cannot define both of them at the same time.

#### Related State Definitions

##### Function Definition
Expand Down Expand Up @@ -3792,7 +3803,7 @@ Service invocation can be done in two different ways:
* Reference a `produced` and `consumed` [event definitions](#Event-Definition) via the `eventRef` property.
* Reference a sub-workflow invocation via the `subFlowRef` property.

Note that `functionRef`, `eventRef`, and `subFlowRef` are mutually exclusive, meaning that only of of them can be
Note that `functionRef`, `eventRef`, and `subFlowRef` are mutually exclusive, meaning that only one of them can be
specified in a single action definition.

The `name` property specifies the action name.
Expand Down Expand Up @@ -4079,8 +4090,7 @@ If it is set to `continue`, if the parent workflow completes, the subflow execut

| Parameter | Description | Type | Required |
| --- | --- | --- | --- |
| errorRef | Reference to a unique workflow error definition | string | yes if errorRefs is not used |
| errorRefs | Reference one or more unique workflow error definition | array | yes if errorRef is not used |
| errorRef or errorRefs | Reference one unique workflow error definition, or multiple unique workflow error definitions | string (errorRef) or array (errorRefs) | yes |
Copy link

@DoisKoh DoisKoh Dec 23, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are errorRef and errorRefs both allowed to be specified in a single Error Definition? Also, is the actually "ErrorRef Definition" rather than "Error Definition"?

Copy link
Member

@ricardozanini ricardozanini Dec 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I understood your question correctly, no. And below we have the explanation:

Note that the `errorRef` and `errorRefs` properties are mutually exclusive, meaning that you can only specify one or the other, but not both at the same time.

Copy link
Contributor Author

@tsurdilo tsurdilo Dec 24, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DoisKoh

Also, is the actually "ErrorRef Definition" rather than "Error Definition"?

not sure i understand, these props are part of the "Error" definition - https://github.com/serverlessworkflow/specification/blob/main/schema/workflow.json#L327

maybe I am missing something

Copy link

@DoisKoh DoisKoh Dec 24, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah right, well it's a bit confusing because... there's separate "ErrorDef" definition, thought it might be more apt to have different names

https://github.com/serverlessworkflow/specification/blob/main/schema/errors.json

| [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 |

<details><summary><strong>Click to view example definition</strong></summary>
Expand Down Expand Up @@ -4125,10 +4135,15 @@ Can be used when `errorRef` is not used. Usable when you want to define multiple
or end definition should be applied.For more info on workflow error handling
referece [this section](#Defining-Errors).

Note that the `errorRef` and `errorRefs` properties are mutually exclusive, meaning that you can only specify one or the other,
but not both at the same time.

The `transition` property defines the transition to the next workflow state in cases when the defined
error happens during runtime execution.

If `transition` is not defined you can also define the `end` property which will end workflow execution at that point.
Note that the `transition` and `end` properties are mutually exclusive, meaning that you can only specify one or the other,
but not both at the same time.

For more information, see the [Workflow Error Handling](#Workflow-Error-Handling) sections.

Expand Down Expand Up @@ -4377,7 +4392,8 @@ The `condition` property of the condition defines an expression (e.g., `${ .appl
parts of the state data input. The condition must evaluate to `true` or `false`.

If the condition is evaluated to `true`, you can specify either the `transition` or `end` definitions
to decide what to do, transition to another workflow state, or end workflow execution.
to decide what to do, transition to another workflow state, or end workflow execution. Note that `transition` and `end`
definitions are mutually exclusive, meaning that you can specify either one or the other, but not both.

##### Switch State Event Conditions

Expand Down Expand Up @@ -4432,6 +4448,9 @@ to decide what to do, transition to another workflow state, or end workflow exec

The `eventDataFilter` property can be used to filter event data when it is received.

Note that `transition` and `end`
definitions are mutually exclusive, meaning that you can specify either one or the other, but not both.

##### Parallel State Branch

| Parameter | Description | Type | Required |
Expand Down