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:
rules:
operation-summary: errorExamples
Given this configuration:
rules:
operation-summary: errorExample of incorrect operation:
post:
tags:
- Customers
operationId: # ...Example of correct operation:
post:
summary: Create a customer
tags:
- Customers
operationId: # ...