Skip to content

workflowId-unique.md

Latest commit

 

History

History
56 lines (41 loc) · 1.42 KB

workflowId-unique.md

File metadata and controls

56 lines (41 loc) · 1.42 KB

workflowId-unique

Requires the workflowId property to be unique across all workflows.

Arazzo Compatibility
1.x ✅

Design principles

According to the spec, the workflowId must be unique across all workflows described in the API description. Duplication could also indicate a typo or other mistake; this rule alerts you if such a situation arises.

Configuration

Option Type Description
severity string Possible values: off, warn, error. Default off.

An example configuration:

rules:
  workflowId-unique: error

Examples

Given the following configuration:

rules:
  workflowId-unique: error

Example of a correct workflows list:

workflows:
  - workflowId: get-museum-hours
    steps:
      - stepId: get-museum-hours
        operationId: museum-api.getMuseumHours
        successCriteria:
          - condition: $statusCode == 200
  - workflowId: get-museum-hours-routine
    steps:
      - stepId: get-museum-hours
        operationId: museum-api.getMuseumHours
        successCriteria:
          - condition: $statusCode == 200

Resources