openapi3gen: inline embedded struct with options-only JSON tag#1229
Merged
Conversation
Collaborator
|
Thanks! |
Contributor
Author
|
Thanks @fenollp - embedded structs with options-only JSON tags inline correctly in openapi3gen now. |
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
openapi3genemits a nested object property instead of inlining an embedded struct when the embedded field's JSON tag carries options but no name, e.g.*NestedStruct \json:",omitempty"`. This inlines such fields, matchingencoding/json`, so the embedded struct's fields are promoted into the parent schema.Background
encoding/jsonflattens an anonymous struct field unless its JSON tag gives it an explicit name;json:",omitempty"has options but no name, so it is still inlined.openapi3gen'sappendFieldsonly inlined anonymous fields when the tag was completely empty (jsonTag == ""), so a nameless-but-optioned tag fell through and became a nested object keyed by the Go field name. EnriqueL8 (#924) and a second commenter both hit this with the common?include=a,b,cquery-parameter pattern, where the wrapper struct is embedded withjson:",omitempty".The fix reads the tag's name segment with
strings.Cut(jsonTag, ",")and, when the name is empty (and the tag is not-), recurses viaappendFieldsexactly as the empty-tag path does. Explicitly-named anonymous fields still become nested objects, andjson:"-"is still skipped. Added regression tests for both pointer and value embedded structs with an options-only tag.Closes #924