no-articles-in-operation-tag-name
Overview
This rule belongs to the openapi-v3-codegen-linting
ruleset and states that:
The operation 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 | Operation tag name should not contain any article such as a , an , or the . |
Code | OPENAPI3CODEGEN_L199 |
Type | Linting |
Rule System | Semantic |
Broad Category | OpenAPI Operations |
Products Impacted | Code Generation, Developer Experience Portal |
Tags | code generation sdks openapi3 openapi semantic linting apimatic operation tag name article A An The |
Suggested Fixes
- Remove all articles from the tag name in the operation object.