fix: Allow explicitely setting the "example" tag to the empty string #773
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 #773 +/- ##
=======================================
Coverage 93.10% 93.10%
=======================================
Files 23 23
Lines 5296 5296
=======================================
Hits 4931 4931
Misses 313 313
Partials 52 52 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes the handling of the "example" tag on fields so that it can be explicitly set to an empty string in both params and schemas.
- Updates the tag parsing in schema.go to use Lookup instead of Get
- Applies a similar update in huma.go to maintain consistency
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| schema.go | Changed tag retrieval for "example" to use Lookup, allowing empty string values. |
| huma.go | Adjusted tag retrieval for "example" to use Lookup, ensuring consistency with schema. |
Comments suppressed due to low confidence (2)
schema.go:561
- [nitpick] Consider renaming the variable 'present' to 'ok' to better align with Go idioms, and remove the extra space before the comma.
if value , present := f.Tag.Lookup("example"); present {
huma.go:166
- [nitpick] Consider renaming the variable 'present' to 'ok' for consistency with common Go practices, and remove the extra space before the comma.
if value , present := f.Tag.Lookup("example"); present {
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.
This simple patch allows to explicitly set the "example" tag of fields in both params an schemas to the empty string "" .