unique-operation-tag
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
Avoid duplicate operation tags in OpenAPI to prevent confusion and inconsistencies in the API documentation. Use distinct tags for each set of related operations to improve the API's quality and usability.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Duplicate operation tags found. |
| Code | OPENAPI3APIMATIC_L233 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Operations |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting tags unique duplicate operation |
Suggested Fixes
- Ensure that OpenAPI specification does not contain any duplicate operation tags.
- Ensure that each tag represents a distinct set of related operations in the API.
- Merge or rename the duplicate tags to accurately represent the related operations in the API.