maximum-info-title-length
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
The title assigned to the API in the Info 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 including files where very long names are forbidden.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | API title length exceeds 50 characters. |
| Code | OPENAPI3CODEGEN_L050 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Info |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | code generation sdks openapi3 openapi semantic linting apimatic length title info api |
Suggested Fixes
- Ensure that the info title does not exceed 50 characters.