arazzo-step-success-actions-validation
Every success action must have a unique "name", and the fields "workflowId" and "stepId" are mutually exclusive.
- Applies to
onSuccess- Selects
$- Function
arazzoStepSuccessActionsValidation- Specs
- Arazzo 1.0
- Message
{{error}}
Use it
This rule ships with OpenLint in spectral:arazzo. Extending the ruleset turns it on:
extends: spectral:arazzo
rules:
arazzo-step-success-actions-validation: error # or off, or another severity
Definition
As defined in @openlint/openlint-rulesets. Functions show by name.
arazzo-step-success-actions-validation:
description: >-
Every success action must have a unique "name", and the fields "workflowId"
and "stepId" are mutually exclusive.
message: '{{error}}'
severity: 0
given: $
then:
function: arazzoStepSuccessActionsValidation
About this rule
Every success action must have a unique name, and the fields workflowId and stepId are mutually exclusive. Any runtime expressions used for workflowId or stepId must be valid and resolve to a defined workflow or step respectively.
Additionally rule checks:
- reusable success action references must be a valid Arazzo runtime expression (e.g.
$components.successActions.<name>) and the referenced action must be existing within the components parameters