no-trailing-leading-spaces-in-header-description
Overview
This rule belongs to the openapi-v3-docsgen-syntax-linting ruleset and states that:
Description of Header Object should not contain any leading or trailing white-space characters.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Header object description contains leading/trailing white-space characters. |
| Code | OPENAPI3DOCSGENSYNTAX_L660 |
| Type | Linting |
| Rule System | Syntax |
| Broad Category | OpenAPI Headers |
| Products Impacted | Developer Experience Portal |
| Tags | documentation generation documentation docs openapi3 openapi syntax linting apimatic header description trailing leading spaces |
Suggested Fixes
- Remove all leading or trailing white-space characters such as spaces, tabs, or line breaks.