fix: Remove all OpenAPI examples from spec before validating #1040
+357
−5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Originally, this PR also ran If you want, I can create a separate PR to fix |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR was made to resolve issue #931. It introduces the following changes:
Commit 189d624:
stripExamplesfunction that takes anOpenAPIV3.DocumentV3orOpenAPIV3.DocumentV3_1, removing allexampleandexamplesproperties. (Note: This only affects examples provided as part of the spec, not user-defined properties calledexampleorexamples).stripExamplesin the spec loader to ensure examples are always discarded and do not affect validation in any way.stripExamplescall, this test fails).These changes are necessary to avoid the validator from erroring out when providing specs that include multiple examples with the same value for a property
id. This is explained in more detail in issue #931, though the proposed solution does not cover all cases. This PR expands on the suggestions and strips all examples, instead of just the component examples.Note:
Originally, this PR also ran
prettier -c -w ./to improve the code style of the repository (49ffda6). But I realized that were way too many changes, so I reverted them in 8dfdb94. Sorry for the back-and-forth.Closes #931