Skip to content
Last updated

operation-operationId

Requires each operation to have an operationId defined.

OASCompatibility
2.0✅
3.0✅
3.1✅

API design principles

The operationId is used by tooling to identify operations (which are otherwise done through scary looking JSON pointers). OpenAPI does not consider operationId a required field, but we'd describe it as a strongly recommended field.

This rule is unopinionated.

Configuration

OptionTypeDescription
severitystringPossible values: off, warn, error. Default warn (in recommended configuration).

An example configuration:

rules:
  operation-operationId: error

Examples

Given this configuration:

rules:
  operation-operationId: error

Example of an incorrect operation:

paths:
  /cars:
    get:
      responses:
        '200':
          $ref: ./Success.yaml

Example of a correct operation:

paths:
  /cars:
    get:
      operationId: GetCar
      responses:
        '200':
          $ref: ./Success.yaml

Resources

 
Next page