Add 'omitzero' support to mark optional fields #742
Merged
Conversation
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #742 +/- ##
=======================================
Coverage 93.00% 93.00%
=======================================
Files 23 23
Lines 5246 5250 +4
=======================================
+ Hits 4879 4883 +4
Misses 315 315
Partials 52 52 ☔ View full report in Codecov by Sentry. |
Contributor
There was a problem hiding this comment.
PR Overview
This pull request adds support for the new "omitzero" field tag introduced in go-1.24 to allow fields with a zero value to be omitted during JSON marshaling.
- Updated schema processing to treat fields tagged with "omitzero" as optional.
- Added tests for both "omitempty" and "omitzero" tag behavior.
- Updated documentation to mention the new tag.
Reviewed Changes
| File | Description |
|---|---|
| schema.go | Integrated "omitzero" flag in required field logic |
| schema_test.go | Added tests to verify behavior for "omitempty" and "omitzero" tags |
| docs/docs/features/request-validation.md | Updated documentation examples to include "omitzero" tag |
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
danielgtaylor
approved these changes
Feb 27, 2025
Owner
danielgtaylor
left a comment
There was a problem hiding this comment.
Awesome thank you @JasirZaeem 👍
Contributor
Author
|
@danielgtaylor Thanks for the great library :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add support for using the new
omitzerofield tag introduced in go-1.24 to mark those fields as optional/not-requiredhttps://tip.golang.org/doc/go1.24#encodingjsonpkgencodingjson
Changes
omitzeroto mark field as optional inschema.goomitemptyandomitzeroinschema_test.gorequest-validation.mddocsLmk if there are other files/places that need changing for this change.