-
-
Notifications
You must be signed in to change notification settings - Fork 248
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(ruleset): rename rule to oas3-examples-value-or-externalValue #1098
Conversation
And update the description to better reflect the targeted field
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this pressing? It can cause breaking changes for people: e.g: If anyone is skipping rules and we rename the rule, they've got a breaking CI.
If its just "this name is not entirely correct" then maybe we can save it for 6.0?
@philsturgeon Will #1059 already in, people will already suffer from this. The idea was to push forward and give the rule a proper name. With #1059 only: With #1059 and this one: |
@philsturgeon Or, I could revive the old rule along with the newly renamed one. Marking the old one as deprecated in the documentation. And log an issue to kill it for 6.0. Thoughts? |
ahh ok I see! Yeah go ahead. |
@P0lip @philsturgeon If both of you agree with the currently proposed changes, could this one get merged, please? |
Thank you! |
And update the description to better reflect the targeted field
Given that #1059 will already impact the user experience with regards to the ruleset, let's get all in an give that rule a more meaningful name.
Checklist
Does this PR introduce a breaking change?
This results in a change in the OAS3 ruleset content (one rule removed and one rule added).