Skip to main content

no-trailing-leading-spaces-in-operation-description

Overview

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

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

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageOperation object description contains leading/trailing white-space characters.
CodeOPENAPI3DOCSGENSYNTAX_L300
TypeLinting
Rule SystemSyntax
Broad CategoryOpenAPI Operations
Products ImpactedDeveloper Experience Portal
Tagsdocumentation generation documentation docs openapi3 openapi syntax linting apimatic operation description trailing leading spaces

Suggested Fixes

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

For More Information