This repository has been archived by the owner on Oct 5, 2023. It is now read-only.
feat: stop running schema dereferencing when running validation #153
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
kanadgupta
approved these changes
Aug 26, 2021
Comment on lines
-40
to
-43
| "@apidevtools/json-schema-ref-parser": "^9.0.7", | ||
| "@apidevtools/swagger-parser": "^10.0.3", | ||
| "js-yaml": "^4.1.0", | ||
| "node-fetch": "^2.6.1", | ||
| "swagger-parser": "^10.0.1", |
| // on this library and our `validate()` method here just needs to tell us if the definition | ||
| // is valid or not we need to clone it before passing it over to `swagger-parser` so as to | ||
| // not run into pass-by-reference problems. | ||
| const clonedSchema = JSON.parse(JSON.stringify(schema)); |
3 tasks
|
Oh one question—is this a breaking change in any of our |
|
In the places that we use this library also call |
1 task
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
🧰 Changes
So a fun fact: when running
.validate()on a schema we first dereference it with.deref()and then whenswagger-parserruns.validate()on it it also does its own dereferencing. Since all.validate()should do is validate something, this work changes it to no longer dereference. Anywhere. Ever.I've also swapped our our usage of
@apidevtools/json-schema-ref-parserfor pure@apidevtools/swagger-parseras the two libraries already depend on each other and expose the same APIs.🧬 QA & Testing
See the test changes I made.