[Bug] Re-introduce json-schema-ref-parser #134
Merged
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
|
Size Change: +3 B (0%) Total Size: 3.36 MB ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 118575a): https://docusaurus-openapi-36b86--pr134-l0hhpjse.web.app (expires Fri, 15 Jul 2022 13:53:33 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
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.
Description
Re-inroduces the
json-schema-ref-parserutility to help handle$refusage that falls outside of the OpenAPI specification. For example,$refs that are used inside descriptions, such as with the CWPP specification.The following variable was added to
openapi.ts:Basically, the behavior is for it to be forced "on" for now. We can make this an API or Plugin option in the future if it makes sense.
Also implemented some basic error handling, for cases in which remote
$refcannot be resolved, e.g. 404, 403, timeout, etc. The error will include what went wrong and which$refwas involved. Failed JSON schema resolution should still fall back to the original parser.Motivation and Context
OpenAPI specs with non-compliant
$refpointers render with missing attributes. For example, local or remote$refin description field would fail to be rendered properly.How Has This Been Tested?
Tested using the CWPP API spec.