no-trailing-leading-spaces-in-schema-enum-element-name
Overview
This rule belongs to the openapi-v3-codegen-syntax-linting
ruleset and states that:
Name of a schema enum element 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 enum item name defined in x-enum-elements extension. |
Code | OPENAPI3CODEGENSYNTAX_L613 |
Type | Linting |
Rule System | Syntax |
Broad Category | OpenAPI Schemas |
Products Impacted | Code Generation, Developer Experience Portal |
Tags | code generation sdks openapi3 openapi syntax linting apimatic schema enum name x-enum-element leading trailing whitespace character |
Suggested Fixes
- Remove all leading or trailing white-space characters such as spaces, tabs, or line breaks from enum item name.
For More Information
- https://docs.apimatic.io/specification-extensions/swagger-codegen-extensions/#enumeration-extensions
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/