at-least-one-operation-tag
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The Operation Object must specify one or more tags using the tags property. Tags are used for logical grouping of operations. This facilitates their discovery and consequently eases API consumption.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Operation object's tags are empty or missing. |
| Code | OPENAPI3APIMATIC_L231 |
| 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 tag operation |
Suggested Fixes
- Ensure that the tag list is present in the Operation Object using the
tagsproperty. - Ensure that the tag list is not empty.
- Ensure that the tag list contains at least one tag entry.
- The tag can represent the resource the operations belong to or a user-friendly category that can help group those operations together.