Skip to content

Conversation

jeremyfiel
Copy link
Contributor

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

@jeremyfiel jeremyfiel force-pushed the feat/operation-deprecation-strategy branch from 5eb0f11 to 4c45929 Compare October 24, 2024 12:58
@tatomyr
Copy link
Contributor

tatomyr commented Dec 2, 2024

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

@adamaltman
Copy link
Member

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

@jeremyfiel jeremyfiel force-pushed the feat/operation-deprecation-strategy branch from 4c45929 to 4422c61 Compare August 28, 2025 15:04
@jeremyfiel
Copy link
Contributor Author

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

@tatomyr
Copy link
Contributor

tatomyr commented Aug 28, 2025

@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
Copy link
Contributor

tatomyr commented Aug 28, 2025

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants