Skip to main content

no-enum-postfix-in-enum-schema-component-key

Overview

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

Enumeration schema key defined in components/schemas section should not contain Enum postfix (case-insensitive).

PropertyValue
EnabledNo
Maximum SeverityWarning
MessageThe Enum (case-insensitive) postfix found for enumeration schema key.
CodeOPENAPI3CODEGEN_L136
TypeLinting
Rule SystemSemantic
Broad CategoryOpenAPI Components
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagscode generation sdks openapi3 openapi semantic linting apimatic components schemas enum key postfix

Suggested Fixes

  • Remove any Enum (case-insensitive) postfix from the enumeration schema key.

For More Information