Disallows multiple tags for an operation.
| OAS | Compatibility |
|---|---|
| 2.0 | ✅ |
| 3.0 | ✅ |
| 3.1 | ✅ |
| 3.2 | ✅ |
OpenAPI tags can be used for different purposes. In many cases, they are used like categories and an operation should belong to a single category.
This rule is opinionated. It simplifies organization. Simple wins.
| Option | Type | Description |
|---|---|---|
| severity | string | Possible values: off, warn, error. Default off (in recommended configuration). |
An example configuration:
rules:
operation-singular-tag: errorGiven this configuration:
rules:
operation-singular-tag: errorExample of incorrect operation:
post:
tags:
- Customers
- Subscriptions
operationId: # ...Example of correct operation:
post:
tags:
- Customers
operationId: # ...