operation-description-override
Replaces the operation description with the designated Markdown in the corresponding file.
API design principles
Sometimes developers generate OpenAPI and the descriptions need to be improved after the fact. This generally happens when you have no permission to edit the source. This decorator provides a way to "overlay" a new description over the source so that as the source changes, the modification can be reapplied
Configuration
| Option | Type | Description |
|---|---|---|
| operationIds | object | REQUIRED. List of key values pairs with operationIds as the key and paths to Markdown files as the value. |
Example of a configuration:
decorators: operation-description-override: operationIds: updatePet: ./my-custom-description.md createPet: ./add-a-pet.md
Examples
See a repository with info, operation, and tag description overrides.