arazzo-advisory

arazzo-advisory is opinionated authoring advice. It checks that source names, workflow IDs and step IDs follow the naming convention the Arazzo specification recommends: letters, numbers, underscores and hyphens.

It is not part of the recommended ruleset. It runs with --hard-mode, in the all Arazzo rules ruleset, or when you switch it on.

Why did this violation appear?

An identifier contains a character outside A-Z, a-z, 0-9, _ and -.

Bad example

workflows:
  - workflowId: read pet
    steps:
      - stepId: read.it
        operationId: $sourceDescriptions.api.read

These are legal. They are also going to hurt, because identifiers end up inside runtime expressions, where a . or a space already means something.

Good example

workflows:
  - workflowId: readPet
    steps:
      - stepId: read-it
        operationId: $sourceDescriptions.api.read

How do I fix this violation?

Rename the identifier, then update every expression that used the old name.

Switch it on

extends: [[vacuum:arazzo, recommended]]
rules:
  arazzo-advisory: true

This rule reports findings from vacuum’s shared Arazzo validation pass, using the arazzoDocument function.