arazzo-workflow-description

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

Why did this violation appear?

A workflow 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
    description: Retrieve a single pet so it can be shown to a customer.
    steps:
      - stepId: read
        operationId: $sourceDescriptions.api.read

How do I fix this violation?

Say what the workflow achieves, not just what it’s called. readPet tells me nothing I couldn’t already see.