Use the extends configuration to extend an existing configuration set. Multiple values are supported, and can include:
- the name of a built-in ruleset
- configuration defined in a custom plugin
- a path or URL to another
redocly.yamlfile
Extends is useful if you use a common ruleset across multiple projects. Define a ruleset in one location, and each project can extend it, with or without modification.
Default ruleset: recommended
If there is no redocly.yaml configuration file, the recommended ruleset is used by default.
The extends configuration is an array of strings.
The array is parsed in the order it is defined, so the later entries in the array overwrite the earlier ones.
To get started, try the following example to configure your project to be based on the minimal ruleset:
extends:
- minimal- APIs configuration - Set per-API configuration options in redocly.yaml for granular control over different API specifications
- Rules configuration - Define linting rules that work with extends configuration for comprehensive API validation
- Extending configuration - Detailed documentation and examples for extending configuration with base rulesets and inheritance
- Configuration options - Explore other project configuration options for comprehensive documentation customization