no-undefined-server-variable

Disallow undefined server variables.

API design principles

If a variable is declared but not defined, it's an error with the specification.

It is important to fix these errors to help clients consume APIs.

Option	Type	Description
severity	string	Possible values: `off`, `warn`, `error`. Default `error` (in `recommended` configuration).

An example configuration:

Copy

Copied

rules:
  no-undefined-server-variable: error

Given this configuration:

Copy

Copied

rules:
  no-undefined-server-variable: error

Example of incorrect server variables:

Copy

Copied

servers:
  - url: 'https://{tenant}/api/v1'

Example of correct server variables:

Copy

Copied

servers:
  - url: 'https://{tenant}/api/v1'
    variables:
      tenant:
        default: api.example.com
        description: Your server host