no-coordinating-conjunctions-in-operation-id
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
The OperationId field in the OpenAPI specification is used to uniquely identify an operation. To ensure consistency and clarity, it is recommended that the OperationId should not contain coordinating conjunctions like and, but, for. 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 | OperationId should not contain any coordinating conjunction such as and, but or for. |
| Code | OPENAPI3CODEGEN_L195 |
| 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 coordinating conjunction and but for |
Suggested Fixes
- Remove all Coordinating Conjunctions such as (but, for, and) from the OperationId.