mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-06 20:57:44 +00:00
88cd624d7a
* docs: Fix typo and remove reference to feature we're planning to drop * docs: re-word the rule explanation, add link to operationId blog post * docs: simplify rule description, pick more relevant related rules to link to * docs: simplify kebab-case explanation
2.1 KiB
2.1 KiB
slug
| slug |
|---|
| /docs/cli/rules/no-unused-components |
no-unused-components
Ensures that every component specified in your API description is used at least once.
In this context, "used" means that a component defined in the components object is referenced elsewhere in the API document with $ref.
| OAS | Compatibility |
|---|---|
| 2.0 | ❌ |
| 3.0 | ✅ |
| 3.1 | ✅ |
flowchart TD
Root ==> Components
style Components fill:#codaf9,stroke:#0044d4,stroke-width:5px
API design principles
This rule 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, turn this rule off.
Configuration
| Option | Type | Description |
|---|---|---|
| severity | string | Possible values: off, warn, error. Default warn (in recommended configuration). |
An example configuration:
rules:
no-unused-components: error
Examples
Given this configuration:
rules:
no-unused-components: error
Example of incorrect components:
openapi: 3.1.0
paths:
/customers:
$ref: '#/components/pathItems/customers'
components:
pathItems:
customers:
# ...
dealers:
# ...
The dealers
PathItemis an unused component.
Example of correct components:
openapi: 3.1.0
paths:
/customers:
$ref: '#/components/pathItems/customers'
components:
pathItems:
customers:
# ...