LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-09 20:57:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7b8f370484bd55564c3c37367077b7c69bcfba1e
redocly-cli/docs/rules/no-undefined-server-variable.md
Adam Altman 9b1239c6d9 fix: rename rule no-empty-enum-servers to no-server-variables-empty-enum (#813) 
* fix: rename rule no-empty-enum-servers to no-server-variables-empty-enum
- fix no-server-example.com docs

* chore: fix snapshots

Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>
2022-08-18 08:07:10 -05:00

1.5 KiB
Raw Blame History

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:

styleguide:
  rules:
    no-undefined-server-variable: error

Examples

Given this configuration:

styleguide:
  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