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: make example-value-or-externalValue only target oas3 document #1059

Merged
merged 5 commits into from
Apr 6, 2020
Merged

fix: make example-value-or-externalValue only target oas3 document #1059

merged 5 commits into from
Apr 6, 2020

Conversation

nulltoken
Copy link
Contributor

Fixes #883.

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

As a side addition, the xor function documentation has (tentatively) been updated to make it more clear with regards to allowed vs required.

This example has been taken from the initial `example-value-or-externalValue`
definition in the ruleset. The rule has since been updated but this doco example
hasn't.

Let's make the doco example a litlle less dependent on the concrete rule implementation.
It's sole purpose is to provide a sample usage of the `xor`function.
@nulltoken nulltoken requested review from philsturgeon and P0lip April 6, 2020 10:11
@nulltoken nulltoken self-assigned this Apr 6, 2020
Copy link
Contributor

@P0lip P0lip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both code and documentation changes look good to me.
Might be good to have @philsturgeon's pair of eyes on this one, as he's by far more familiar with OpenAPI than I am.

@P0lip P0lip changed the title Make example-value-or-externalValue only target oas3 document fix: make example-value-or-externalValue only target oas3 document Apr 6, 2020
@P0lip P0lip added the t/bug Something isn't working label Apr 6, 2020
@P0lip P0lip merged commit d3b5384 into stoplightio:develop Apr 6, 2020
@nulltoken nulltoken deleted the ntk/example-value-or-externalValue_oas3 branch April 7, 2020 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t/bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

example-value-or-externalValue should only target OAS3
3 participants