no-trailing-leading-spaces-in-response-description

Overview

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

Description of an Response Object should not contain any leading or trailing white-space characters.

Property	Value
Enabled	Yes
Maximum Severity	Warning
Message	Response object description contains leading/trailing white-space characters.
Code	OPENAPI3DOCSGENSYNTAX_L520
Type	Linting
Rule System	Syntax
Broad Category	OpenAPI Responses
Products Impacted	Developer Experience Portal
Tags	documentation generation documentation docs openapi3 openapi syntax linting apimatic response 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#response-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/