From 282c64b7f61ed345386c4f72e78397f9aeeba1a0 Mon Sep 17 00:00:00 2001 From: Frank Kilcommins Date: Wed, 31 Jan 2024 17:10:26 +0000 Subject: [PATCH] Move explanation regarding similar criteria for success/failure action objects to step (#121) --- versions/1.0.0.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/versions/1.0.0.md b/versions/1.0.0.md index 5d8def4..7b5ad9f 100644 --- a/versions/1.0.0.md +++ b/versions/1.0.0.md @@ -328,8 +328,8 @@ Field Name | Type | Description parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters to pass to an operation or workflow as referenced by `operationId`, `operationRef`, or `workflowId`. If a Reference Object is provided, it MUST link to parameters defined in [components/parameters](#component-object). dependsOn | [`string`] | A list of steps that MUST be completed before this step can be processed. This helps to ensure workflow steps are executed in the correct order and that dependent steps are not processed in parallel. The values provided MUST be the be the `stepId` which uniquely references a step. successCriteria | [[Criterion Object](#criterion-object)] | A list of assertions to determine the success of the step. Each assertion is described using a [Criterion Object](#criterion-object). All assertions `MUST` be satisfied for the step to be deemed successful. -onSuccess | [[Success Action Object](#success-action-object)] | An array of success action objects that specify what to do upon step success. If omitted, the next sequential step shall be executed as the default behavior. -onFailure | [[Failure Action Object](#failure-action-object)] | An array of failure action objects that specify what to do upon step failure. If omitted, the default behavior is to break and return. +onSuccess | [[Success Action Object](#success-action-object)] | An array of success action objects that specify what to do upon step success. If omitted, the next sequential step shall be executed as the default behavior. If multiple success actions have similar `criteria`, the first sequential action matching the criteria SHALL be the action executed. +onFailure | [[Failure Action Object](#failure-action-object)] | An array of failure action objects that specify what to do upon step failure. If omitted, the default behavior is to break and return. If multiple failure actions have similar `criteria`, the first sequential action matching the criteria SHALL be the action executed. outputs | Map[`string`, {expression}] | A map between a friendly name and a dynamic output value defined using a [runtime expression](#runtime-expressions). The name MUST use keys that match the regular expression: `^[a-zA-Z0-9\.\-_]+$`. This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -473,7 +473,6 @@ Field Name | Type | Description criteria | [[Criterion Object](#criterion-object)] | A list of assertions to determine if this action SHALL be executed. Each assertion is described using a [Criterion Object](#criterion-object). All criteria assertions `MUST` be satisfied for the action to be executed. -**Note -** should multiple success actions have similar `criteria`, the first sequential action matching the criteria SHALL be the action executed. This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -506,7 +505,6 @@ Field Name | Type | Description retryLimit | `integer` | A non-negative integer indicating how many attempts to retry the step MAY be attempted before failing the overall step. If not specified then a single retry SHALL be attempted. This field only applies when the `type` field value is `"retry"`. The `retryLimit` MUST be exhausted prior to executing subsequent failure actions. criteria | [[Criterion Object](#criterion-object)] | A list of assertions to determine if this action SHALL be executed. Each assertion is described using a [Criterion Object](#criterion-object). -**Note -** should multiple success actions have similar `criteria`, the first sequential action matching the criteria SHALL be the action executed. This object MAY be extended with [Specification Extensions](#specification-extensions).