Skip to content
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

Merged
merged 3 commits into from
Apr 23, 2020
Merged

fix(ruleset): rename rule to oas3-examples-value-or-externalValue #1098

merged 3 commits into from
Apr 23, 2020

Conversation

nulltoken
Copy link
Contributor

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

  • Tests added / updated
  • Docs added / updated

Does this PR introduce a breaking change?

  • Yes
  • No (From the API standpoint)

This results in a change in the OAS3 ruleset content (one rule removed and one rule added).

⚠️ This will impact users who tweaked the rule severity or silenced it

@nulltoken nulltoken marked this pull request as ready for review April 17, 2020 15:54
@nulltoken nulltoken requested a review from P0lip April 17, 2020 15:54
@nulltoken nulltoken self-assigned this Apr 17, 2020
@nulltoken nulltoken requested a review from philsturgeon April 17, 2020 15:54
Copy link
Contributor

@philsturgeon philsturgeon left a 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?

@nulltoken
Copy link
Contributor Author

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.

@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:
example-value-or-externalValue -> oas3-example-value-or-externalValue

With #1059 and this one:
example-value-or-externalValue -> oas3-examples-value-or-externalValue

@nulltoken
Copy link
Contributor Author

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

@philsturgeon
Copy link
Contributor

ahh ok I see! Yeah go ahead.

@nulltoken
Copy link
Contributor Author

@P0lip @philsturgeon If both of you agree with the currently proposed changes, could this one get merged, please?

@philsturgeon philsturgeon merged commit 74f1160 into stoplightio:develop Apr 23, 2020
@philsturgeon
Copy link
Contributor

Thank you!

@nulltoken nulltoken deleted the ntk/examples branch April 24, 2020 06:22
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