fix(api-symmetry): handle nested reference schemas #639
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
If reference schemas were nested in composed properties on the canonical schema, the code would not resolve them the way it would for non-nested reference schemas. This moves the resolving code to the constraint checker, so that every schema and applicator sub-schema will be resolved if it is a reference. Signed-off-by: Dustin Popp <[email protected]>
dpopp07
commented
Oct 11, 2023
| @@ -145,60 +145,43 @@ function checkForGraphFragmentPattern( | |||
| schemaFinder | |||
| ) { | |||
| let variantOmitsProperties = false; | |||
| let isValidGraphFragment = true; | |||
There was a problem hiding this comment.
This didn't necessarily cause problems but it did make debugging a lot harder, since once this got set, every call to isGraphFragment would return false. Now, we use a local variable which is probably a more clean and appropriate overall.
pyrooka
approved these changes
Oct 16, 2023
ibm-devx-sdk
pushed a commit
that referenced
this pull request
Oct 16, 2023
## @ibm-cloud/openapi-ruleset [1.14.2](https://github.com/IBM/openapi-validator/compare/@ibm-cloud/[email protected]...@ibm-cloud/[email protected]) (2023-10-16) ### Bug Fixes * **api-symmetry:** handle nested reference schemas ([#639](#639)) ([603e689](603e689))
|
🎉 This PR is included in version 1.14.2 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.14.2 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.3.1 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
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.
If reference schemas were nested in composed properties on the canonical schema, the code would not resolve them the way it would for non-nested reference schemas.
This moves the resolving code to the constraint checker, so that every schema and applicator sub-schema will be resolved if it is a reference.