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.

Configuration

An example configuration:

rules:
  no-undefined-server-variable: error

Examples

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

Related rules

• no-empty-servers
• no-server-example.com
• no-server-variables-empty-enum

Resources

• Rule source
• Server variable docs