Add clarification on mutually exclusive properties #566
Conversation
tsurdilo
requested review from
cdavernas,
manuelstein and
ricardozanini
as code owners
tsurdilo
added
the
change: documentation
specification.md
Outdated
| | [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 | | ||
| | [metadata](#Workflow-Metadata) | Metadata information| object | yes if "transition" is not defined | |
There was a problem hiding this comment.
Is this really the case?
specification.md
Outdated
| 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. | ||
|
|
||
| Note that `transition` and `end` properties are mutually exclusive, meaning that you cannot define both of them at the same time. |
There was a problem hiding this comment.
Isn’t this duplicate of the line 4155
| | --- | --- | --- | --- | | ||
| | 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 | |
There was a problem hiding this comment.
Are errorRef and errorRefs both allowed to be specified in a single Error Definition? Also, is the actually "ErrorRef Definition" rather than "Error Definition"?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
tsurdilo
force-pushed
the
clarifyexclusiveprops
branch
from
85e2774 to
a2b943a
Compare
Signed-off-by: Tihomir Surdilovic <tihomir@temporal.io>
Signed-off-by: Tihomir Surdilovic <tihomir@temporal.io>
tsurdilo
force-pushed
the
clarifyexclusiveprops
branch
from
a2b943a to
6f81c32
Compare
4 participants
Signed-off-by: Tihomir Surdilovic tihomir@temporal.io
Many thanks for submitting your Pull Request ❤️!
Please specify parts this PR updates:
What this PR does / why we need it:
adds clarification on some mutually exclusive properties
Special notes for reviewers:
Additional information (if needed):