vacuum:arazzo, all enables all 18 built-in Arazzo rules, including the two pieces of
authoring advice that are not part of the recommended defaults.
extends: [[vacuum:arazzo, all]]
You can also use --hard-mode with an Arazzo document. Hard mode enables every Arazzo rule. It does not drag
OpenAPI or OWASP rules into a workflow document.
Rules
| Rule | Severity | Recommended |
|---|---|---|
| arazzo-structure | error | yes |
| arazzo-duplicate-id | error | yes |
| arazzo-reference | error | yes |
| arazzo-parameter | error | yes |
| arazzo-expression | error | yes |
| arazzo-selector | error | yes |
| arazzo-dependency | error | yes |
| arazzo-input-schema | error | yes |
| arazzo-source-type | error | yes |
| arazzo-validation-incomplete | warn | yes |
| arazzo-info-description | warn | yes |
| arazzo-workflow-description | warn | yes |
| arazzo-step-description | warn | yes |
| arazzo-no-script-tags-in-markdown | warn | yes |
| arazzo-info-summary | hint | yes |
| arazzo-workflow-summary | hint | yes |
| arazzo-advisory | warn | no |
| arazzo-step-operationPath | hint | no |
Just want one of the extra rules?
You don’t need hard mode for that. Extend the recommended ruleset and switch the rule on.
extends: [[vacuum:arazzo, recommended]]
rules:
arazzo-advisory: true
Generate all Arazzo rules
RuleSet generated for 'arazzo-all', written to 'my-arazzo-rules-arazzo-all.yaml'