mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-06 04:21:09 +00:00
40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
# 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 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.
|
|
|
|
## Configuration
|
|
|
|
| Option | Type | Description |
|
|
| -------- | ------ | ------------------------------------------------------------------------------------------- |
|
|
| filePath | string | **REQUIRED.** The relative path to a Markdown file containing the desired info description. |
|
|
|
|
Example of a configuration:
|
|
|
|
```yaml
|
|
decorators:
|
|
info-description-override:
|
|
filePath: ./my-custom-description.md
|
|
```
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
See a repository with [info, operation, and tag description overrides](https://github.com/redocly-demo/decorators-demo).
|
|
|
|
## Related decorators
|
|
|
|
- [operation-description-override](./operation-description-override.md)
|
|
- [tag-description-override](./tag-description-override.md)
|
|
|
|
## Resources
|
|
|
|
- [Decorator source](https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/decorators/common/info-description-override.ts)
|
|
- [Blog post about Overlays](../../../blog/openapi-overlays.md)
|