fix(oas31): resolve schema refs regardless of expand depth#10806
Open
maruthang wants to merge 1 commit intoswagger-api:masterfrom
Open
fix(oas31): resolve schema refs regardless of expand depth#10806maruthang wants to merge 1 commit intoswagger-api:masterfrom
maruthang wants to merge 1 commit intoswagger-api:masterfrom
Conversation
The Models section useEffect only triggered schema resolution when defaultModelsExpandDepth > 1 or a schema was individually expanded. With the default depth of 1, discriminator + allOf $ref values were never resolved. Simplify the condition to resolve whenever the section is open and schemas are not yet resolved. Fixes swagger-api#10336
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
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
Simplify the schema resolution condition in the OAS 3.1 Models component to trigger resolution whenever the Models section is open and schemas haven't been resolved yet, regardless of
defaultModelsExpandDepth.Previously, the
useEffectonly requested resolution of["components", "schemas"]whendefaultModelsExpandDepth > 1OR when at least one schema was individually expanded in the layout state. With the default depth of 1,$refvalues inallOf(used with discriminator patterns) were never resolved, causing "could not resolve reference" errors.Motivation and Context
Fixes #10336
The
defaultModelsExpandDepthconfig should control UI expansion depth, not whether schema references get resolved. Schemas need to be resolved to render correctly regardless of expansion depth.How Has This Been Tested?
defaultModelsExpandDepth=1(the bug scenario)Screenshots (if appropriate):
N/A
Checklist
My PR contains...
src/is unmodified: changes to documentation, CI, metadata, etc.)package.json)My changes...
Documentation
Automated tests