operation-operationId

Requires each operation to have an operationId defined.

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

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

Related rules

• operation-operationId-unique
• operation-operationId-url-safe

Resources

• OperationIds make good API design - Redocly Blog
• Rule source
• Operation object docs
• Consider using configurable rules for more specific rules for operationIds such as length, casing, and pattern enforcement.