Throw dereferencing errors #22
Merged
Conversation
This file contains hidden or 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
taras
force-pushed
the
taras/fix-error-reporting
branch
from
dca0c7c to
e9e9e77
Compare
BREAKING CHANGE: derefencing errors are thrown
taras
force-pushed
the
taras/fix-error-reporting
branch
from
0f0c79e to
88bfe27
Compare
philsturgeon
approved these changes
Jun 3, 2021
|
Thanks for this, good change! |
|
🎉 This PR is included in version 2.0.0 🎉 The release is available on: 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.
Motivation
I'm working on converting schemas from backstage.io into OpenAPI for backstage/backstage#2566. The schema in master seems to use incorrect references so I was surprised to find that json-schema-to-openapi-schema did not fail. It was quite confusing because the
$refdidn't get resolved but the function did not fail.Once I started looking at the code, I realized that
resolver.resolvesucceeds even if dereferencing fails. I believe@stoplight/json-ref-resolvershould actually throw an error in this case but that would be a substantial breaking change to that library. Instead, I'm just fixing error reporting in this library.Approach
Throw an error when dereferencing has errors in results. I added a test for this.