Skip to content

no-undefined-server-variable.md

Latest commit

 

History

History
79 lines (55 loc) · 1.83 KB

no-undefined-server-variable.md

File metadata and controls

79 lines (55 loc) · 1.83 KB
slug
/docs/cli/rules/oas/no-undefined-server-variable

no-undefined-server-variable

Disallow undefined server variables.

OAS Compatibility
2.0 ❌
3.0 ✅
3.1 ✅
3.2 ✅ 
flowchart TD

Root ==> ServersList --> Server --> ServerVariable

style ServerVariable fill:#codaf9,stroke:#0044d4,stroke-width:5px
Loading

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

Option Type Description
severity string Possible values: off, warn, error. Default error (in recommended 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

Resources