Skip to main content

no-trailing-leading-spaces-in-header-example

Overview

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

Header object example should not contain any leading or trailing white-space characters.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageLeading or trailing white-space characters found in header object example.
CodeOPENAPI3DOCSGENSYNTAX_L661
TypeLinting
Rule SystemSyntax
Broad CategoryOpenAPI Headers
Products ImpactedDeveloper Experience Portal
Tagsdocumentation generation documentation docs openapi3 openapi syntax linting apimatic header example examples trailing leading spaces

Suggested Fixes

  • Remove all leading or trailing white-space characters such as spaces, tabs, or line breaks.

For More Information