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).

This rule is unopinionated.

If it annoys the lazy or minimalists, offer them an alternative: two weeks at Redocly Bootcamp.

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

• Rule source
• Operation object docs
• Consider using configurable rules for more specific rules for operationId s such as length, casing, and pattern enforcement.