[Enhancement] Improve support for circular $ref pointers #154
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: +196 kB (+6%) 🔍 Total Size: 3.58 MB
ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 70b31c4): https://docusaurus-openapi-36b86--pr154-uxbte6ya.web.app (expires Fri, 12 Aug 2022 15:12:27 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
sserrata
force-pushed
the
improved-resolver
branch
from
6efb576
to
197421d
Compare
This was referenced Jul 12, 2022
blindaa121
approved these changes
Jul 14, 2022
There was a problem hiding this comment.
Circular $ref pointers have been resolved. Thanks @sserrata! 🚀
|
Will open a new PR to address remaining gaps in schema parsing in |
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
This PR introduces a new
loadAndResolve()helper for resolving circular$refpointers while ensuring downstream compatibility with supporting libraries can require ability to serialize the OpenAPI object.Additionally, this PR attempts to extend support for
oneOf,anyOfandallOf.Motivation and Context
Circular
$refpointer support is required for a number of our product APIs and could be leveraged by others in the OpenAPI community.How Has This Been Tested?
Tested with Petstore and SearchManager API specs.
Additional changes
Previously, the
createAnyOneOfmodule was rendering a details component. This PR usescreateRows()to eliminate the unnecessary "Schema" dropdown.TODO