operation-operationId-unique

Requires unique operationId values for each operation.

OAS Compatibility
2.0
3.0
3.1

API design principle

The operationId is used by tooling to identify operations (which are otherwise done through scary looking JSON pointers).

The operationId should be unique (used only once in an OpenAPI definition).

This rule is unopinionated.

Configuration

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

An example configuration:

Copy
Copied
styleguide:
  rules:
    operation-operationId-unique: error

Examples

Given this configuration:

Copy
Copied
styleguide:
  rules:
    operation-operationId-unique: error

Example of incorrect operations:

Copy
Copied
paths:
  /cars:
    get:
      operationId: Car
      # ...
    post:
      operationId: Car
      # ...

Example of correct operations:

Copy
Copied
paths:
  /cars:
    get:
      operationId: getCar
      # ...
    post:
      operationId: postCar
      # ...

Related rules

Resources