Last updated

spec

Ensures that your API document conforms to the OpenAPI specification.

OASCompatibility
2.0
3.0
3.1

The default setting for this rule (in the recommended and minimal configuration) is error.

This is an essential rule that should not be turned off except in rare and special cases.

API design principles

It's important to conform to the specification so that tools work with your API document. Doing so makes writing and maintenance of API descriptions easier.

Configuration

OptionTypeDescription
severitystringPossible values: off, warn, error. Default error (in recommended configuration).

An example configuration:

rules:
  spec: error

Examples

Given this configuration:

rules:
  spec: error

Example of an incorrect spec:

openapi: 3.0.0
info:
  version: 1.0.0
paths: {}

Example of a correct spec:

openapi: 3.0.0
info:
  title: Ultra API
  version: 1.0.0
paths: {}

Resources