LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-06 04:21:09 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
de80612b5541f2508cbe97fd26eb50f24fc9646d
redocly-cli/docs/rules/no-undefined-server-variable.md
Lorna Jane Mitchell de80612b55 chore: Run prettier on all docs files (#1334)
2023-11-17 09:45:03 +00:00

1.8 KiB
Raw Blame History

slug
slug
/docs/cli/rules/no-undefined-server-variable

no-undefined-server-variable

Disallow undefined server variables.

OAS Compatibility
2.0 ❌
3.0 ✅
3.1 ✅ 
flowchart TD

root ==> ServersList --> Server --> ServerVariable

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

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