no-trailing-leading-spaces-in-additional-header-description

Overview

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

Additional header description 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 additional header description.
Code	OPENAPI3DOCSGENSYNTAX_L841
Type	Linting
Rule System	Syntax
Broad Category	OpenAPI Security Schemes
Products Impacted	Developer Experience Portal
Tags	documentation generation documentation docs openapi3 openapi syntax linting apimatic additional headers description trailing leading spaces x-additional-headers

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-codegen-extensions/#additional-headers
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/