fix(openapi3): handle yaml:",inline" tag for embedded structs#2141
Open
fix(openapi3): handle yaml:",inline" tag for embedded structs#2141
Conversation
The v3 field parser's ShouldSkip() function was incorrectly skipping embedded struct fields that had yaml:",inline" tags but no json tag. This caused the embedded struct's fields to be omitted from the generated OpenAPI schema. The issue was that ShouldSkip() checked if JsonName() returned empty string and skipped the field. But for embedded fields with yaml:",inline" (and no json tag), JsonName() returns "" which incorrectly triggered the skip. The fix changes ShouldSkip() to only skip fields explicitly marked with json:"-", matching the behavior of the Swagger 2.0 parser. Fixes swaggo#2140 Signed-off-by: Juan Antonio Osorio <ozz@stacklok.com>
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
1 participant
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.
Describe the PR
Fix embedded struct fields being omitted from OpenAPI 3.x schema when using
yaml:",inline"tag.The v3 field parser's
ShouldSkip()was incorrectly skipping fields whenJsonName()returned an empty string. This caused embedded struct fields withyaml:",inline"(but no json tag) to be skipped entirely.The fix changes
ShouldSkip()to only skip fields explicitly marked withjson:"-", matching the behavior of the Swagger 2.0 parser.Relation issue
Fixes #2140