Skip to main content



This rule belongs to the openapi-v3-docsgen-linting ruleset and states that:

In an OpenAPI specification, the Server Variable Object describes the value of an individual variable within a specific Server Object. This rule ensures that the Server Variable Object includes a non-empty description property, which is essential to describe the purpose of the variable.

Maximum SeverityInformation
MessageMissing or empty description property for server variable object.
Rule SystemSemantic
Broad CategoryOpenAPI Servers
Products ImpactedDeveloper Experience Portal
Tagsdocumentation generation documentation docs openapi3 openapi semantic linting apimatic server variable description

Suggested Fixes

  • For each Server Variable Object, add a clear and concise description that accurately reflects the intended purpose of the variable.

For More Information