operation-tag-defined
Disallows use of tags in operations that aren't globally defined.
| OAS | Compatibility |
|---|---|
| 2.0 | ✅ |
| 3.0 | ✅ |
| 3.1 | ✅ |
API design principles
OpenAPI tags can be used for different purposes. Tags are declared in the root of the OpenAPI description. Then, they are used in operations. They are recommmended for grouping common operations within your api description.
This rule first checks if a tag exists on the operation. Subsequently, if an operation uses a tag, it must be defined in the root tags declaration. This rule helps prevent typos and tag explosion.
Configuration
| Option | Type | Description |
|---|---|---|
| severity | string | Possible values: off, warn, error. Default off (in recommended configuration). |
An example configuration:
rules:
operation-tag-defined: errorExamples
Given this configuration:
rules:
operation-tag-defined: errorExample of incorrect operation:
tags:
- name: Anchovy
paths:
/customers:
post:
tags:
- Customers
operationId: # ...Example of correct operation:
tags:
- name: Anchovy
- name: Customers
paths:
/customers:
post:
tags:
- Customers
operationId: # ...