fix: change Explode field from bool to *bool for proper serialization#132
Open
curiosity-the-rover wants to merge 1 commit intosv-tools:mainfrom
Open
fix: change Explode field from bool to *bool for proper serialization#132curiosity-the-rover wants to merge 1 commit intosv-tools:mainfrom
curiosity-the-rover wants to merge 1 commit intosv-tools:mainfrom
Conversation
When Explode is bool with omitempty, false values are not serialized to JSON/YAML output. This prevents users from explicitly setting explode: false in OpenAPI specs. Changing to *bool allows: - nil: omit the field (use default behavior) - &true: serialize as 'explode: true' - &false: serialize as 'explode: false' Affects: Parameter, Header, Encoding structs and their builders.
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.
Problem
When
ExplodeisboolwithomitemptyJSON/YAML tag,falsevalues are not serialized to the output. This prevents users from explicitly settingexplode: falsein OpenAPI specs.For example:
Solution
Change
Explodefromboolto*boolin:Parameterstruct (parameter.go)Headerstruct (header.go)Encodingstruct (encoding.go)This allows:
nil→ omit the field (use default behavior)&true→ serialize asexplode: true&false→ serialize asexplode: falseThe builder methods are updated to take address of the value.
Changes
parameter.go:Explode bool→Explode *bool, builder updatedheader.go:Explode bool→Explode *bool, builder updatedencoding.go:Explode bool→Explode *bool, builder updatedTesting
All existing tests pass.
Related
This change is needed to support explicit
explode: falsegeneration in tools like swaggo/swag.