LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-09 20:57:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
1f0ca52ce083f21bc1b39ec4f5da8a18ece5daf1
redocly-cli/docs/rules/operation-singular-tag.md
Lorna Jane Mitchell de80612b55 chore: Run prettier on all docs files (#1334)
2023-11-17 09:45:03 +00:00

1.6 KiB
Raw Blame History

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

operation-singular-tag

Disallows multiple tags for an operation.

OAS Compatibility
2.0 ✅
3.0 ✅
3.1 ✅

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.

Configuration

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

An example configuration:

rules:
  operation-singular-tag: error

Examples

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: # ...

Related rules

Resources