Fixes (#10535) : Properly render example field in request schema as plain JSON #10602
+9
−2
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 change ensures that example objects in request schemas are displayed as standard JSON in Swagger UI, rather than with Immutable.js prefixes like OrderedMap.
Motivation and Context
This change fix Swagger UI would display Immutable.js type prefixes in example fields that would confuse the api users.
Fixes #10535
How Has This Been Tested?
I did manually tested with arrays and objects in req schema in localhost server.
Screenshots (if appropriate):
Checklist
My PR contains...
src/
is unmodified: changes to documentation, CI, metadata, etc.)package.json
)My changes...
Documentation
Automated tests
Test cases that can prove the fix is not breakable