Skip to content
Last updated

sourceDescriptions-not-empty

The Source Description must have at least one entry.

ArazzoCompatibility
1.x✅

Design principles

Source descriptions are an important part of an Arazzo description, and at least one entry must exist. If the list is empty, this could indicate an omission or another problem; this rule alerts you if that happens.

Configuration

OptionTypeDescription
severitystringPossible values: off, warn, error. Default off.

An example configuration:

rules:
  sourceDescriptions-not-empty: error

Examples

Given the following configuration:

rules:
  sourceDescriptions-not-empty: error

Example of a correct usage:

arazzo: '1.0.1'
info:
  title: Cool API
  version: 1.0.0
  description: A cool API
sourceDescriptions:
  - name: museum-api
    type: openapi
    url: openapi.yaml
  - name: another-api
    type: openapi
    url: openapi.yaml
workflows:
  - workflowId: get-museum-hours
    description: This workflow demonstrates how to get the museum opening hours and buy tickets.
    parameters:
      - in: header
        name: Authorization
        value: Basic Og==
    steps:
      - stepId: get-museum-hours
        description: >-
          Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
        operationId: $sourceDescriptions.museum-api.getMuseumHours
        successCriteria:
          - condition: $statusCode == 200

Resources