operation-summary

Enforce that every operation has a summary.

OAS Compatibility
2.0
3.0
3.1

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.

Configuration

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

An example configuration:

Copy
Copied
styleguide:
  rules:
    operation-summary: error

Examples

Given this configuration:

Copy
Copied
styleguide:
  rules:
    operation-summary: error

Example of incorrect operation:

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

Example of correct operation:

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

Related rules

Resources