tag-name-uses-title-case
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
When defining tags for OpenAPI, use TitleCase, which means capitalizing the first letter of each word in the tag except for conjunctions, prepositions, and articles. This makes the tags more readable.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Warning |
| Message | Tag name is not in TitleCase format. |
| Code | OPENAPI3CODEGEN_L581 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Tags |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | code generation sdks openapi3 openapi semantic linting apimatic tag name title case |
Suggested Fixes
- Ensure that the tag name is properly formatted with the first letter of each word capitalized, except for articles, conjunctions, and prepositions.