redocly-cli-cookbook
redocly-cli-cookbook copied to clipboard
feat(rules): add new configurable rules for deprecated operations
New ruleset for enforcing a deprecation strategy with Deprecation, Sunset and Link headers.
I'd prefer having this as a new ruleset instead of separate rules. First, they are closely related and it makes sense to use them together. Second, there's no particular complexity in defining such rules, and the value comes not from the configuration examples, but rather from using the rules themselves. Then, it would be really easy to use the ruleset with this config in redocly.yaml:
extends:
- recommended # or something
- https://..... # the ruleset uri
Where would that ruleset be hosted @tatomyr ? It seems this is good as an example.
I'm willing to create the redocly for this request, just let me know where to host it
@adamaltman the simplest way is to define the ruleset right here and use the link to the raw file. E.g., we can reference this ruleset with the following link: https://raw.githubusercontent.com/Redocly/redocly-cli-cookbook/refs/heads/main/rulesets/common-mistakes/redocly.yaml.
@jeremyfiel I'd host it here for transparency. Just use the rulesets/ folder for your example.