no-trailing-leading-spaces-in-schema-example
Overview
This rule belongs to the openapi-v3-docsgen-syntax-linting
ruleset and states that:
Schema Object example should not contain any leading or trailing white-space characters.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Warning |
Message | Schema object example contains leading/trailing white-space characters. |
Code | OPENAPI3DOCSGENSYNTAX_L753 |
Type | Linting |
Rule System | Syntax |
Broad Category | OpenAPI Schemas |
Products Impacted | Developer Experience Portal |
Tags | documentation generation documentation docs openapi3 openapi syntax linting apimatic schema example trailing leading spaces |
Suggested Fixes
- Remove all leading or trailing white-space characters such as spaces, tabs, or line breaks.