fix: support empty object example value for map[string]struct{}#2111
Open
shindonghwi wants to merge 1 commit intoswaggo:masterfrom
Open
fix: support empty object example value for map[string]struct{}#2111shindonghwi wants to merge 1 commit intoswaggo:masterfrom
shindonghwi wants to merge 1 commit intoswaggo:masterfrom
Conversation
This adds support for parsing `{}` as an empty object in example values.
Before this fix, using `swaggertype:"object,object" example:"key1:{},key2:{}"`
for a `map[string]struct{}` field would fail with:
"object is unsupported type in example value `{}`"
Now the empty object `{}` is correctly parsed as an empty map.
Fixes swaggo#2018
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.
Summary
{}as an empty object in example valuesobject is unsupported type in example value {}when usingmap[string]struct{}with examplesProblem
When using a
map[string]struct{}field with swaggertype and example tags:The parser would fail with:
Solution
Added a special case in
defineTypeOfExampleto handle empty object{}as a valid example value, returning an emptymap[string]any{}.Test plan
map[string]struct{}with empty object valuesFixes #2018