pre-defined-operation-tag-in-global-tags
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
Each tag used in the API must be defined in the root level tags list of the API specification. This ensures that all tags used in the API are properly defined, which helps with documentation generation and other tooling. Please check the root level tags list and ensure that all tags used in the API are properly defined.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Undefined tag used in operation object. |
| Code | OPENAPI3APIMATIC_L235 |
| 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 operation undefined |
Suggested Fixes
- Ensure that the tag used in the operation is defined in the root level tags list of the API specification.
- Check the spelling and capitalization of the tag used in the operation.
- If the tag used in the operation is not defined in the root level tags list, add it to the list and ensure that it is properly formatted.
- Verify that there are no typos or syntax errors in the API specification.