no-articles-in-tag-name
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
The tag name should not contain articles like a, an, or the. These words can make the name of the operation unnecessarily long and can make it harder to read and understand.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Warning |
| Message | Tag name should not contain any article such as a, an, or the. |
| Code | OPENAPI3CODEGEN_L582 |
| 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 articles A An The |
Suggested Fixes
- Remove all articles from the tag name.