redocly-cli-cookbook icon indicating copy to clipboard operation
redocly-cli-cookbook copied to clipboard

feat(rules): add new configurable rules for deprecated operations

Open jeremyfiel opened this issue 1 year ago • 1 comments
trafficstars

New ruleset for enforcing a deprecation strategy with Deprecation, Sunset and Link headers.

jeremyfiel avatar Oct 23 '24 22:10 jeremyfiel

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

tatomyr avatar Dec 02 '24 14:12 tatomyr

Where would that ruleset be hosted @tatomyr ? It seems this is good as an example.

adamaltman avatar Aug 28 '25 14:08 adamaltman

I'm willing to create the redocly for this request, just let me know where to host it

jeremyfiel avatar Aug 28 '25 15:08 jeremyfiel

@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.

tatomyr avatar Aug 28 '25 15:08 tatomyr

@jeremyfiel I'd host it here for transparency. Just use the rulesets/ folder for your example.

tatomyr avatar Aug 28 '25 15:08 tatomyr