spectral:arazzo warn on by default

arazzo-workflow-workflowId

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

Applies to
workflowId
Selects
$.workflows[*]
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-workflow-workflowId: warn   # or off, or another severity

Definition

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

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

About this rule

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

Sources