info-description-override
Replaces the info 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 you won't lose your modifications.
Configuration
Option | Type | Description |
---|---|---|
filePath | string | REQUIRED. The relative path to a Markdown file containing the desired info description. |
Example of a configuration:
decorators:
info-description-override:
filePath: ./my-custom-description.md
Examples
See a repository with info, operation, and tag description overrides.