operation-operationId

Requires each operation to have an operationId defined.

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

This rule is unopinionated.

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

Configuration

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

An example configuration:

Copy
Copied
styleguide:
  rules:
    operation-operationId: error

Examples

Given this configuration:

Copy
Copied
styleguide:
  rules:
    operation-operationId: error

Example of an incorrect operation:

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

Example of a correct operation:

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

Related rules

Resources