maximum-schema-title-length
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
The title assigned to the Schema Object using the title property must not exceed 50 characters. Longer titles can compromise on user-friendliness. In addition to that, the title is used for naming various components generated during code generation where it is possible that very long names are forbidden. Details should go into the description field instead.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Schema title length exceeds 50 characters. |
| Code | OPENAPI3CODEGEN_L617 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Schemas |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | code generation sdks openapi3 openapi semantic linting apimatic length title schema |
Suggested Fixes
- Keep the schema title short and code-friendly.
- Ensure that schema title length does not exceed 50 characters.
- Place any extra details about the schema in the
descriptionproperty instead.