Articles
Author
vacuum
Quick Start
💥 Try It Now
About vacuum
Installing
Why?
Concepts
FAQ
AsyncAPI
Arazzo
Ignoring Violations
JSON Schema
Changelog
Configuring
Generate API Docs
VSCode Plugin
GitHub Action
CLI Commands
Lint
vacuum Report
Dashboard
Generate Docs
HTML Report
Spectral Report
References
Upgrade vacuum
Version
Bundle Spec
Generate RuleSet
Language Server
Apply Overlay
Schema
Open Collection
Change Detection
Exit Codes
Developer API
API Quick Start
Spec Index
RuleResultSet
Loading RuleSet
Custom Go
Custom JS
Non-OpenAPI Files
Functions
Core Functions
OpenAPI Functions
OWASP Functions
JSON Schema Funcs
AsyncAPI Funcs
Arazzo Funcs
Rules
Examples
OWASP
Channels
Operations/Paths
Messages
Schemas
Spec Information
Servers
Validation
Descriptions
Tags
Security
Arazzo
RuleSets
What are they?
Sharing RuleSets
No Rules/Off
OpenAPI Default
Custom RuleSets
OWASP Rules
JSON Schema Rules
AsyncAPI Default
AsyncAPI All Rules
Arazzo Default
Arazzo All Rules
  • GitHub GitHub Repo stars
  • Discord Discord Server
    • ✨ New! Try the OpenAPI Doctor ✨ The OpenAPI Doctor
    Recommended

    arazzo-step-description

    Formats: Severity:

    arazzo-step-description checks that every step in every workflow has a description.

    Why did this violation appear?

    A step is missing description, or the value is empty.

    Bad example

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

    Good example

    workflows:
  - workflowId: readPet
    steps:
      - stepId: read
        description: Fetch the pet, we need its ID for the next step.
        operationId: $sourceDescriptions.api.read

    How do I fix this violation?

    Describe why the step is there. The operation it calls is already in the file. The reason it’s being called isn’t.