no-trailing-leading-spaces-in-example-description

Overview

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

Description of an example 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 example object description.
Code	OPENAPI3DOCSGENSYNTAX_L590
Type	Linting
Rule System	Syntax
Broad Category	OpenAPI Examples
Products Impacted	Developer Experience Portal
Tags	documentation generation documentation docs openapi3 openapi syntax linting apimatic example examples description trailing leading spaces

Suggested Fixes

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

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#example-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/