server-parameter-description-exists
Overview
This rule belongs to the openapi-v3-docsgen-linting ruleset and states that:
The description provides additional details or context about the parameter used in the Server configuration. The Server Parameter should include a description.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Information |
| Message | Description is missing for the Server Parameter. |
| Code | OPENAPI3DOCSGEN_L153 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Servers |
| Products Impacted | Developer Experience Portal |
| Tags | documentation generation documentation docs openapi3 openapi semantic linting apimatic environment Server parameter description x-server-configuration |
Suggested Fixes
- Add a user-friendly description for the Server Parameter.
For More Information
- https://docs.apimatic.io/specification-extensions/swagger-server-configuration-extensions/#environment-object
- https://docs.apimatic.io/specification-extensions/swagger-server-configuration-extensions/#parameter-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/