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
9199b2bab7c66cdbfb30bf24838f70a2fc28a218
redocly-cli/docs/rules/no-server-variables-empty-enum.md
redocly-bot 9199b2bab7 sync: Synced local 'docs/' with remote 'docs/cli/'
2023-10-09 16:35:49 +00:00

2.1 KiB
Raw Blame History

redirects, slug
redirects slug
/docs/cli/rules/no-empty-enum-servers/
to
/docs/cli/rules/no-server-variables-empty-enum/
/docs/cli/rules/no-server-variables-empty-enum

no-server-variables-empty-enum

Disallow server variables without enum list defined.

OAS Compatibility
2.0 ❌
3.0 ✅
3.1 ✅ 
flowchart TD

root ==> ServersList --> Server --> ServerVariables

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

API design principles

If you use server variables, there are generally two kinds:

  • tenant-driven
  • environment-driven

In the case of environment-driven variables, you may want to predefine all of the possible values.

Configuration

Option Type Description
severity string Possible values: off, warn, error. Default error (in recommended configuration).

An example configuration:

rules:
  no-server-variables-empty-enum: error

Examples

Given this configuration:

rules:
  no-server-variables-empty-enum: error

Example of incorrect server variables:

servers:
  - url: 'https://{env}.example.com/api/v1'
    variables:
      env:
        default: api
        description: Environment

Example of correct server:

servers:
  - url: 'https://{env}.example.com/api/v1'
    variables:
      env:
        default: api
        description: Environment
        enum:
          - api
          - sandbox
          - qa
          - test
          - dev

Related rules

Resources