Decorators
All Redocly CLI decorators are listed on this page.
To learn how to configure decorators, read more about their configuration syntax.
Decorators run during the bundle
command.
They are commonly used to add, remove, or change content.
List of decorators
Changing descriptions
Changing examples
Removing content
Have an idea for a decorator? We might build it for you and give it to the world. Open a GitHub issue and let us know.
Decorator configuration syntax
The following example shows how to configure a decorator in the Redocly configuration file.
apis:
main:
root: ./openapi/openapi.yaml
decorators:
decorator-name:
decorator-option: example-value
decorators:
decorator-name:
decorator-option: example-value
Optionally, you may specify severity
as one of decorator options in the configuration. Severity can be set to error
, warn
or off
, similar to how it works with rules. When it's specified, any problem reported from the decorator is treated according to the configured severity. Setting severity: off
disables the decorator altogether. Generally, it's not necessary to specify severity
for decorator configuration except for troubleshooting purposes.
Custom decorators
You can create your own decorators using custom plugins.
For example, with custom decorators you can: