slug
/docs/cli/rules/oas/operation-singular-tag

operation-singular-tag

Disallows multiple tags for an operation.

API design principles

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: error

Given this configuration:

rules:
  operation-singular-tag: error

Example of incorrect operation:

post:
  tags:
    - Customers
    - Subscriptions
  operationId: # ...

Example of correct operation:

post:
  tags:
    - Customers
  operationId: # ...