slug
/docs/cli/rules/oas/operation-summary

operation-summary

Enforce that every operation has a summary.

API design principles

Operation summaries are used to generate API docs. Redocly uses the summary as the header for the operation, as well as the sidebar navigation text.

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

An example configuration:

rules:
  operation-summary: error

Given this configuration:

rules:
  operation-summary: error

Example of incorrect operation:

post:
  tags:
    - Customers
  operationId: # ...

Example of correct operation:

post:
  summary: Create a customer
  tags:
    - Customers
  operationId: # ...