no-articles-in-operation-id
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
The OperationId is a unique identifier for an operation, and it should reflect the purpose or functionality of the operation. Using articles like a, an, the in the OperationId can make it unnecessarily long and difficult to read. Therefore, it is recommended to avoid using articles in the OperationId.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Warning |
| Message | OperationId should not contain any article such as a, an or the. |
| Code | OPENAPI3CODEGEN_L194 |
| 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 operationId aticals A An The |
Suggested Fixes
- Remove all articles from the OperationId.
- Make sure that id does not contain any spaces or underscores.