Make docs for required more explicit regarding boolean values #1261
Conversation
This file contains 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
…zero value i.e. false
deankarn
approved these changes
Jun 1, 2024
denyskon
referenced
this pull request
in denyskon/postalion
Jun 1, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [github.com/go-playground/validator/v10](https://togithub.com/go-playground/validator) | `v10.20.0` -> `v10.21.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>go-playground/validator (github.com/go-playground/validator/v10)</summary> ### [`v10.21.0`](https://togithub.com/go-playground/validator/releases/tag/v10.21.0): Release 10.21.0 [Compare Source](https://togithub.com/go-playground/validator/compare/v10.20.0...v10.21.0) #### What's Changed - MongoDB validator improved by [@​pixel365](https://togithub.com/pixel365) in [https://github.com/go-playground/validator/pull/1196](https://togithub.com/go-playground/validator/pull/1196) - change codes bool value to struct{} by [@​nar10z](https://togithub.com/nar10z) in [https://github.com/go-playground/validator/pull/1270](https://togithub.com/go-playground/validator/pull/1270) - Fix grammar issues in comments, tests, field names by [@​alexandear](https://togithub.com/alexandear) in [https://github.com/go-playground/validator/pull/1262](https://togithub.com/go-playground/validator/pull/1262) - Make docs for required more explicit regarding boolean values by [@​alexongh](https://togithub.com/alexongh) in [https://github.com/go-playground/validator/pull/1261](https://togithub.com/go-playground/validator/pull/1261) - Fix Japanese translation of max-items, lt-items and lte-items error by [@​Tomoki108](https://togithub.com/Tomoki108) in [https://github.com/go-playground/validator/pull/1250](https://togithub.com/go-playground/validator/pull/1250) - chore: fix some comments by [@​pavedroad](https://togithub.com/pavedroad) in [https://github.com/go-playground/validator/pull/1242](https://togithub.com/go-playground/validator/pull/1242) - Polish language support by [@​thinkofher](https://togithub.com/thinkofher) in [https://github.com/go-playground/validator/pull/1217](https://togithub.com/go-playground/validator/pull/1217) #### New Contributors - [@​pixel365](https://togithub.com/pixel365) made their first contribution in [https://github.com/go-playground/validator/pull/1196](https://togithub.com/go-playground/validator/pull/1196) - [@​nar10z](https://togithub.com/nar10z) made their first contribution in [https://github.com/go-playground/validator/pull/1270](https://togithub.com/go-playground/validator/pull/1270) - [@​alexongh](https://togithub.com/alexongh) made their first contribution in [https://github.com/go-playground/validator/pull/1261](https://togithub.com/go-playground/validator/pull/1261) - [@​Tomoki108](https://togithub.com/Tomoki108) made their first contribution in [https://github.com/go-playground/validator/pull/1250](https://togithub.com/go-playground/validator/pull/1250) - [@​pavedroad](https://togithub.com/pavedroad) made their first contribution in [https://github.com/go-playground/validator/pull/1242](https://togithub.com/go-playground/validator/pull/1242) - [@​thinkofher](https://togithub.com/thinkofher) made their first contribution in [https://github.com/go-playground/validator/pull/1217](https://togithub.com/go-playground/validator/pull/1217) **Full Changelog**: go-playground/validator@v10.20.0...v10.21.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/denyskon/postalion). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNzcuOCIsInVwZGF0ZWRJblZlciI6IjM3LjM3Ny44IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
renovate bot
referenced
this pull request
in nobl9/sloctl
Jun 1, 2024
….0 (#130) [](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [github.com/go-playground/validator/v10](https://togithub.com/go-playground/validator) | `v10.20.0` -> `v10.21.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>go-playground/validator (github.com/go-playground/validator/v10)</summary> ### [`v10.21.0`](https://togithub.com/go-playground/validator/releases/tag/v10.21.0): Release 10.21.0 [Compare Source](https://togithub.com/go-playground/validator/compare/v10.20.0...v10.21.0) #### What's Changed - MongoDB validator improved by [@​pixel365](https://togithub.com/pixel365) in [https://github.com/go-playground/validator/pull/1196](https://togithub.com/go-playground/validator/pull/1196) - change codes bool value to struct{} by [@​nar10z](https://togithub.com/nar10z) in [https://github.com/go-playground/validator/pull/1270](https://togithub.com/go-playground/validator/pull/1270) - Fix grammar issues in comments, tests, field names by [@​alexandear](https://togithub.com/alexandear) in [https://github.com/go-playground/validator/pull/1262](https://togithub.com/go-playground/validator/pull/1262) - Make docs for required more explicit regarding boolean values by [@​alexongh](https://togithub.com/alexongh) in [https://github.com/go-playground/validator/pull/1261](https://togithub.com/go-playground/validator/pull/1261) - Fix Japanese translation of max-items, lt-items and lte-items error by [@​Tomoki108](https://togithub.com/Tomoki108) in [https://github.com/go-playground/validator/pull/1250](https://togithub.com/go-playground/validator/pull/1250) - chore: fix some comments by [@​pavedroad](https://togithub.com/pavedroad) in [https://github.com/go-playground/validator/pull/1242](https://togithub.com/go-playground/validator/pull/1242) - Polish language support by [@​thinkofher](https://togithub.com/thinkofher) in [https://github.com/go-playground/validator/pull/1217](https://togithub.com/go-playground/validator/pull/1217) #### New Contributors - [@​pixel365](https://togithub.com/pixel365) made their first contribution in [https://github.com/go-playground/validator/pull/1196](https://togithub.com/go-playground/validator/pull/1196) - [@​nar10z](https://togithub.com/nar10z) made their first contribution in [https://github.com/go-playground/validator/pull/1270](https://togithub.com/go-playground/validator/pull/1270) - [@​alexongh](https://togithub.com/alexongh) made their first contribution in [https://github.com/go-playground/validator/pull/1261](https://togithub.com/go-playground/validator/pull/1261) - [@​Tomoki108](https://togithub.com/Tomoki108) made their first contribution in [https://github.com/go-playground/validator/pull/1250](https://togithub.com/go-playground/validator/pull/1250) - [@​pavedroad](https://togithub.com/pavedroad) made their first contribution in [https://github.com/go-playground/validator/pull/1242](https://togithub.com/go-playground/validator/pull/1242) - [@​thinkofher](https://togithub.com/thinkofher) made their first contribution in [https://github.com/go-playground/validator/pull/1217](https://togithub.com/go-playground/validator/pull/1217) **Full Changelog**: go-playground/validator@v10.20.0...v10.21.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 10pm every weekday,before 5am every weekday,every weekend" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/nobl9/sloctl). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNzcuOCIsInVwZGF0ZWRJblZlciI6IjM3LjM3Ny44IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiLCJnb2xhbmciLCJyZW5vdmF0ZSJdfQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
MrAlias
referenced
this pull request
in open-telemetry/opentelemetry-go-contrib
Jun 3, 2024
…v10.21.0 (#5705) [](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [github.com/go-playground/validator/v10](https://togithub.com/go-playground/validator) | `v10.20.0` -> `v10.21.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>go-playground/validator (github.com/go-playground/validator/v10)</summary> ### [`v10.21.0`](https://togithub.com/go-playground/validator/releases/tag/v10.21.0): Release 10.21.0 [Compare Source](https://togithub.com/go-playground/validator/compare/v10.20.0...v10.21.0) #### What's Changed - MongoDB validator improved by [@​pixel365](https://togithub.com/pixel365) in [https://github.com/go-playground/validator/pull/1196](https://togithub.com/go-playground/validator/pull/1196) - change codes bool value to struct{} by [@​nar10z](https://togithub.com/nar10z) in [https://github.com/go-playground/validator/pull/1270](https://togithub.com/go-playground/validator/pull/1270) - Fix grammar issues in comments, tests, field names by [@​alexandear](https://togithub.com/alexandear) in [https://github.com/go-playground/validator/pull/1262](https://togithub.com/go-playground/validator/pull/1262) - Make docs for required more explicit regarding boolean values by [@​alexongh](https://togithub.com/alexongh) in [https://github.com/go-playground/validator/pull/1261](https://togithub.com/go-playground/validator/pull/1261) - Fix Japanese translation of max-items, lt-items and lte-items error by [@​Tomoki108](https://togithub.com/Tomoki108) in [https://github.com/go-playground/validator/pull/1250](https://togithub.com/go-playground/validator/pull/1250) - chore: fix some comments by [@​pavedroad](https://togithub.com/pavedroad) in [https://github.com/go-playground/validator/pull/1242](https://togithub.com/go-playground/validator/pull/1242) - Polish language support by [@​thinkofher](https://togithub.com/thinkofher) in [https://github.com/go-playground/validator/pull/1217](https://togithub.com/go-playground/validator/pull/1217) #### New Contributors - [@​pixel365](https://togithub.com/pixel365) made their first contribution in [https://github.com/go-playground/validator/pull/1196](https://togithub.com/go-playground/validator/pull/1196) - [@​nar10z](https://togithub.com/nar10z) made their first contribution in [https://github.com/go-playground/validator/pull/1270](https://togithub.com/go-playground/validator/pull/1270) - [@​alexongh](https://togithub.com/alexongh) made their first contribution in [https://github.com/go-playground/validator/pull/1261](https://togithub.com/go-playground/validator/pull/1261) - [@​Tomoki108](https://togithub.com/Tomoki108) made their first contribution in [https://github.com/go-playground/validator/pull/1250](https://togithub.com/go-playground/validator/pull/1250) - [@​pavedroad](https://togithub.com/pavedroad) made their first contribution in [https://github.com/go-playground/validator/pull/1242](https://togithub.com/go-playground/validator/pull/1242) - [@​thinkofher](https://togithub.com/thinkofher) made their first contribution in [https://github.com/go-playground/validator/pull/1217](https://togithub.com/go-playground/validator/pull/1217) **Full Changelog**: go-playground/validator@v10.20.0...v10.21.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/open-telemetry/opentelemetry-go-contrib). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNzcuOCIsInVwZGF0ZWRJblZlciI6IjM3LjM3Ny44IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJTa2lwIENoYW5nZWxvZyIsImRlcGVuZGVuY2llcyJdfQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
renovate bot
referenced
this pull request
in jippi/dottie
Jun 5, 2024
…0.21.0 in go.mod (#50) [](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [github.com/go-playground/validator/v10](https://togithub.com/go-playground/validator) | `v10.17.0` -> `v10.21.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>go-playground/validator (github.com/go-playground/validator/v10)</summary> ### [`v10.21.0`](https://togithub.com/go-playground/validator/releases/tag/v10.21.0): Release 10.21.0 [Compare Source](https://togithub.com/go-playground/validator/compare/v10.20.0...v10.21.0) #### What's Changed - MongoDB validator improved by [@​pixel365](https://togithub.com/pixel365) in [https://github.com/go-playground/validator/pull/1196](https://togithub.com/go-playground/validator/pull/1196) - change codes bool value to struct{} by [@​nar10z](https://togithub.com/nar10z) in [https://github.com/go-playground/validator/pull/1270](https://togithub.com/go-playground/validator/pull/1270) - Fix grammar issues in comments, tests, field names by [@​alexandear](https://togithub.com/alexandear) in [https://github.com/go-playground/validator/pull/1262](https://togithub.com/go-playground/validator/pull/1262) - Make docs for required more explicit regarding boolean values by [@​alexongh](https://togithub.com/alexongh) in [https://github.com/go-playground/validator/pull/1261](https://togithub.com/go-playground/validator/pull/1261) - Fix Japanese translation of max-items, lt-items and lte-items error by [@​Tomoki108](https://togithub.com/Tomoki108) in [https://github.com/go-playground/validator/pull/1250](https://togithub.com/go-playground/validator/pull/1250) - chore: fix some comments by [@​pavedroad](https://togithub.com/pavedroad) in [https://github.com/go-playground/validator/pull/1242](https://togithub.com/go-playground/validator/pull/1242) - Polish language support by [@​thinkofher](https://togithub.com/thinkofher) in [https://github.com/go-playground/validator/pull/1217](https://togithub.com/go-playground/validator/pull/1217) #### New Contributors - [@​pixel365](https://togithub.com/pixel365) made their first contribution in [https://github.com/go-playground/validator/pull/1196](https://togithub.com/go-playground/validator/pull/1196) - [@​nar10z](https://togithub.com/nar10z) made their first contribution in [https://github.com/go-playground/validator/pull/1270](https://togithub.com/go-playground/validator/pull/1270) - [@​alexongh](https://togithub.com/alexongh) made their first contribution in [https://github.com/go-playground/validator/pull/1261](https://togithub.com/go-playground/validator/pull/1261) - [@​Tomoki108](https://togithub.com/Tomoki108) made their first contribution in [https://github.com/go-playground/validator/pull/1250](https://togithub.com/go-playground/validator/pull/1250) - [@​pavedroad](https://togithub.com/pavedroad) made their first contribution in [https://github.com/go-playground/validator/pull/1242](https://togithub.com/go-playground/validator/pull/1242) - [@​thinkofher](https://togithub.com/thinkofher) made their first contribution in [https://github.com/go-playground/validator/pull/1217](https://togithub.com/go-playground/validator/pull/1217) **Full Changelog**: go-playground/validator@v10.20.0...v10.21.0 ### [`v10.20.0`](https://togithub.com/go-playground/validator/releases/tag/v10.20.0): Release 10.20.0 [Compare Source](https://togithub.com/go-playground/validator/compare/v10.19.0...v10.20.0) #### What's Changed - Fix ULID should case-insensitive by [@​akayj](https://togithub.com/akayj) in [https://github.com/go-playground/validator/pull/1258](https://togithub.com/go-playground/validator/pull/1258) - feat: add base32 validator tag by [@​jamesatkin-myndup](https://togithub.com/jamesatkin-myndup) in [https://github.com/go-playground/validator/pull/1253](https://togithub.com/go-playground/validator/pull/1253) - Add EU countries validator by [@​masv3971](https://togithub.com/masv3971) in [https://github.com/go-playground/validator/pull/1252](https://togithub.com/go-playground/validator/pull/1252) #### New Contributors - [@​akayj](https://togithub.com/akayj) made their first contribution in [https://github.com/go-playground/validator/pull/1258](https://togithub.com/go-playground/validator/pull/1258) - [@​jamesatkin-myndup](https://togithub.com/jamesatkin-myndup) made their first contribution in [https://github.com/go-playground/validator/pull/1253](https://togithub.com/go-playground/validator/pull/1253) - [@​masv3971](https://togithub.com/masv3971) made their first contribution in [https://github.com/go-playground/validator/pull/1252](https://togithub.com/go-playground/validator/pull/1252) **Full Changelog**: go-playground/validator@v10.19.0...v10.20.0 ### [`v10.19.0`](https://togithub.com/go-playground/validator/releases/tag/v10.19.0): Release 10.19.0 [Compare Source](https://togithub.com/go-playground/validator/compare/v10.18.0...v10.19.0) #### What was added? Added opt-in ability to validate private fields in [PR](https://togithub.com/go-playground/validator/pull/1234), thanks [@​nikolaianohyn](https://togithub.com/nikolaianohyn) via the new `WithPrivateFieldValidation` option when initializing validator. ### [`v10.18.0`](https://togithub.com/go-playground/validator/releases/tag/v10.18.0): Release 10.18.0 [Compare Source](https://togithub.com/go-playground/validator/compare/v10.17.0...v10.18.0) #### What Changed? Updated all dependencies to address dependant alerts, [#​1205](https://togithub.com/go-playground/validator/issues/1205) and [#​1220](https://togithub.com/go-playground/validator/issues/1220) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "* */8 * * *" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/jippi/dottie). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zODguMSIsInVwZGF0ZWRJblZlciI6IjM3LjM4OC4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiXX0=--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
|
This, in my opinion, is a little unexpected. Judging from the name required only, I expected that a false boolean value would be ok, since a value was provided. Can we recover the literal meaning of required instead of being kidnapped by go's zero value ？ |
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.
requiredvalidates that the value is not the data types default zero value. Forbooleanthe default zero value isfalse. Therefore, afalseboolean value would be interpreted as not matching therequiredvalidation and fail.This, in my opinion, is a little unexpected. Judging from the name
requiredonly, I expected that afalseboolean value would be ok, since a value was provided.Nevertheless, in my opinion, this behavior should be documented a little more explicitly. Which is why I propose this change to the docs.
(this is only a docs change)
@go-playground/validator-maintainers