no-undefined-server-variable
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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:

rules:
  no-undefined-server-variable: error

Given this configuration:

rules:
  no-undefined-server-variable: error

Example of incorrect server variables:

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

Example of correct server variables:

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