no-trailing-leading-spaces-in-server-parameter-description
Overview
This rule belongs to the openapi-v3-docsgen-syntax-linting ruleset and states that:
Description of a server parameter object should not contain any leading or trailing white-space characters.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Leading or trailing white-space characters found in server parameter description. |
| Code | OPENAPI3DOCSGENSYNTAX_L153 |
| Type | Linting |
| Rule System | Syntax |
| Broad Category | OpenAPI Servers |
| Products Impacted | Developer Experience Portal |
| Tags | documentation generation documentation docs openapi3 openapi syntax linting apimatic environment Server parameter description leading trailing spaces x-server-configuration |
Suggested Fixes
- Remove all leading or trailing white-space characters such as spaces, tabs, or line breaks.
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/