fix(response): handle empty examples map in OAS3 responses#10803
Open
maruthang wants to merge 1 commit intoswagger-api:masterfrom
Open
fix(response): handle empty examples map in OAS3 responses#10803maruthang wants to merge 1 commit intoswagger-api:masterfrom
maruthang wants to merge 1 commit intoswagger-api:masterfrom
Conversation
Guard against empty `examples: {}` maps in OAS3 response content
types that caused "could not render" errors by checking the map
is non-empty before accessing keys.
Fixes swagger-api#7823
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
Guard against empty
examples: {}maps in OAS3 response content types that caused "could not render" errors. When a response's media type has an empty examples map,examplesForMediaType.keySeq().first()throws because the map has no keys. This fix checks that the examples map is a non-empty Immutable Map before accessing its keys.Motivation and Context
Fixes #7823
When an OAS3 spec includes an empty
examples: {}in a response content type, Swagger UI crashes with a "could not render" error. This is because the code attempts to call.keySeq().first()on an empty (or null) Immutable Map without checking if it's valid first.How Has This Been Tested?
<Response>component with an OAS3 response containingexamples: {}and asserts no error is thrownScreenshots (if appropriate):
N/A
Checklist
My PR contains...
src/is unmodified: changes to documentation, CI, metadata, etc.)package.json)My changes...
Documentation
Automated tests