operation-tag-defined

Disallows use of tags in operations that aren't globally defined.

API design principles

OpenAPI tags can be used for different purposes. Tags are declared in the root of the OpenAPI definition. Then, they are used in operations.

This rule says that if an operation uses a tag, it must be defined in the root tags declaration. This rule helps prevent typos and tag explosion.

Option	Type	Description
severity	string	Possible values: `off`, `warn`, `error`. Default `off` (in `recommended` configuration).

An example configuration:

Copy

Copied

rules:
  operation-tag-defined: error

Given this configuration:

Copy

Copied

rules:
  operation-tag-defined: error

Example of incorrect operation:

Copy

Copied

tags:
  - name: Anchovy
paths:
  /customers:
    post:
      tags:
        - Customers
      operationId: # ...

Example of correct operation:

Copy

Copied

tags:
  - name: Anchovy
  - name: Customers
paths:
  /customers:
    post:
      tags:
        - Customers
      operationId: # ...