spectral:arazzo warn on by default

arazzo-step-stepId

Step "stepId" should follow the pattern "^[A-Za-z0-9_\-]+$".

Applies to
stepId
Selects
$.workflows[*].steps[*]
Function
pattern
Specs
Arazzo 1.0

Use it

This rule ships with OpenLint in spectral:arazzo. Extending the ruleset turns it on:

extends: spectral:arazzo
rules:
  arazzo-step-stepId: warn   # or off, or another severity

Definition

As defined in @openlint/openlint-rulesets. Functions show by name.

arazzo-step-stepId:
  description: 'Step "stepId" should follow the pattern "^[A-Za-z0-9_\-]+$".'
  severity: warn
  given: '$.workflows[*].steps[*]'
  then:
    field: stepId
    function: pattern
    functionOptions:
      match: '^[A-Za-z0-9_\-]+$'

About this rule

Step stepId defined should follow the pattern ^[A-Za-z0-9_\\-]+$. This is good practice as tools and libraries can use the stepId to uniquely identify a step.

Sources