Skip to main content

schema-component-key-exceeds-maximum-allowed-length

Overview

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

The length of the schema key must not exceed 100 characters. Keys exceeding this limit will cause failures in Code Generation, Docs Generation, and Portal Generation.

PropertyValue
EnabledYes
Maximum SeverityError
MessageSchema key exceeds the maximum allowed length of 100 characters.
CodeOPENAPI3CODEGEN_L138
TypeLinting
Rule SystemSemantic
Broad CategoryOpenAPI Components
Products ImpactedCode Generation, Developer Experience Portal
Tagscode generation sdks openapi3 openapi semantic linting apimatic components schemas key length 100

Suggested Fixes

  • Shorten the schema key so that it doesn't exceed 100 characters.
  • Try to keep the key under 50 characters for best results.

For More Information