sourceDescriptions-type

The type property of the Source Description object must be either openapi or arazzo.

Design principles

Arazzo currently supports either an OpenAPI file or another Arazzo file as the source description. This rule makes sure that the type is clearly identified and is one of the supported types.

Configuration

An example configuration:

rules:
  sourceDescriptions-type: error

Examples

Given the following configuration:

rules:
  sourceDescriptions-type: error

Example of a correct sourceDescriptions list:

sourceDescriptions:
  - name: museum-api
    type: openapi
    url: ../openapi.yaml
  - name: tickets-from-museum-api
    type: arazzo
    url: museum-tickets.arazzo.yaml

Related rules

• sourceDescription-name-unique

Resources

• Rule source