Replaces the info description with the designated Markdown in the corresponding file.
Sometimes developers generate OpenAPI and the descriptions need to be improved after the fact. This generally happens when you don't have 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 modifications can be reapplied.
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
See a repository with info, operation, and tag description overrides.