feat: enhance $ref resolution for OpenAPI 3.1.0 #10612
Open
+249
−3
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.
fixes: #10584
Description
This PR fixes rendering and sample generation for JSON Schema 2020-12 $ref-based schemas in Swagger UI where schemas self-reference. It addresses three related problems:
File changes
src\core\plugins\json-schema-2020-12\fn.js -
Object type label display / type inference (makeGetType/getType)
src\core\plugins\json-schema-2020-12-samples\fn\get-json-sample-schema.js -
Attempt to resolve top-level local $ref before calling the sample generator so nested array items that reference an object schema produce object samples
src\core\plugins\json-schema-2020-12\components\JSONSchema\JSONSchema.jsx,
src\core\plugins\json-schema-2020-12\components\keywords$ref.jsx,
src\core\plugins\json-schema-2020-12\hoc.jsx
UI rendering for the $ref keyword in Schema
Note: A portion of the code changes and the PR description were produced with the help of an AI coding assistant.
Motivation and Context
How Has This Been Tested?
Locally tested. Added screenshot
Screenshots:
Tested with the yaml file -
Checklist
My PR contains...
src/is unmodified: changes to documentation, CI, metadata, etc.)package.json)My changes...
Documentation
Automated tests