maximum-schema-component-key-length
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
The length of the schema key should not exceed 50 characters, which is considered a best practice. Excessive schema key lengths can create readability issues and can cause issues in code generation. Keeping them concise helps to ensure that they are easily understandable and convey their purpose clearly.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Schema key exceeds 50 characters. |
| Code | OPENAPI3CODEGEN_L137 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Components |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | code generation sdks openapi3 openapi semantic linting apimatic components schemas key length 50 |
Suggested Fixes
- Shorten the name length so that it does not exceed the limit.
- Try to keep the name under 50 characters.