arazzo-workflow-summary
arazzo-workflow-summary checks that every workflow has a summary.
Why did this violation appear?
A workflow is missing summary, or the value is empty.
Bad example
workflows:
- workflowId: readPet
description: Retrieve a single pet so it can be shown to a customer.
steps:
- stepId: read
operationId: $sourceDescriptions.api.read
Good example
workflows:
- workflowId: readPet
summary: Read a pet.
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?
Add a short one-line summary to the workflow.