LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-06 04:21:09 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
baddec02e05b8b165c0419e84058ebaf8ccb85c1
redocly-cli/docs/decorators/remove-unused-components.md
redocly-bot 33502fb2ee sync: Synced local 'docs/' with remote 'docs/cli/'
2023-01-08 17:08:09 +00:00

1.2 KiB
Raw Blame History

remove-unused-components

Removes unused components from the bundle output.

In this context, "used" means that a component defined in the components object is referenced elsewhere in the API document with $ref.

API design principles

This decorator is intended to help security-focused enterprises prevent data leaks. Components can leak schemas, parameters, and other properties that may be unused in the exposed APIs, but used internally elsewhere.

However, your API document may contain common components used in other APIs. If that describes your use-case, please avoid using this decorator.

Configuration

Example of a configuration:

decorators:
  remove-unused-components: on

Examples

Read the article on no-unused-components rule to see examples.

Related decorators

Resources

  • The Redocly CLI bundle command supports an option called --remove-unused-components. Use it to automatically clean up any unused components from your OpenAPI document while bundling it.
  • Components docs