Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make docs for required more explicit regarding boolean values #1261

Merged
merged 1 commit into from
Jun 1, 2024

Conversation

alexongh
Copy link
Contributor

required validates that the value is not the data types default zero value. For boolean the default zero value is false. Therefore, a false boolean value would be interpreted as not matching the required validation and fail.

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.

Nevertheless, in my opinion, this behavior should be documented a little more explicitly. Which is why I propose this change to the docs.

  • Tests exist or have been written that cover this particular change.
    (this is only a docs change)

@go-playground/validator-maintainers

@alexongh alexongh requested a review from a team as a code owner May 11, 2024 16:33
@coveralls
Copy link

Coverage Status

coverage: 74.243%. remained the same
when pulling 043e9ee on alexongh:master
into e20b948 on go-playground:master.

@deankarn deankarn merged commit d3e28c4 into go-playground:master Jun 1, 2024
15 checks passed
denyskon pushed a commit to denyskon/postalion that referenced this pull request Jun 1, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](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` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fgo-playground%2fvalidator%2fv10/v10.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fgo-playground%2fvalidator%2fv10/v10.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fgo-playground%2fvalidator%2fv10/v10.20.0/v10.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fgo-playground%2fvalidator%2fv10/v10.20.0/v10.21.0?slim=true)](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
[@&#8203;pixel365](https://togithub.com/pixel365) in
[go-playground/validator#1196
- change codes bool value to struct{} by
[@&#8203;nar10z](https://togithub.com/nar10z) in
[go-playground/validator#1270
- Fix grammar issues in comments, tests, field names by
[@&#8203;alexandear](https://togithub.com/alexandear) in
[go-playground/validator#1262
- Make docs for required more explicit regarding boolean values by
[@&#8203;alexongh](https://togithub.com/alexongh) in
[go-playground/validator#1261
- Fix Japanese translation of max-items, lt-items and lte-items error by
[@&#8203;Tomoki108](https://togithub.com/Tomoki108) in
[go-playground/validator#1250
- chore: fix some comments by
[@&#8203;pavedroad](https://togithub.com/pavedroad) in
[go-playground/validator#1242
- Polish language support by
[@&#8203;thinkofher](https://togithub.com/thinkofher) in
[go-playground/validator#1217

#### New Contributors

- [@&#8203;pixel365](https://togithub.com/pixel365) made their first
contribution in
[go-playground/validator#1196
- [@&#8203;nar10z](https://togithub.com/nar10z) made their first
contribution in
[go-playground/validator#1270
- [@&#8203;alexongh](https://togithub.com/alexongh) made their first
contribution in
[go-playground/validator#1261
- [@&#8203;Tomoki108](https://togithub.com/Tomoki108) made their first
contribution in
[go-playground/validator#1250
- [@&#8203;pavedroad](https://togithub.com/pavedroad) made their first
contribution in
[go-playground/validator#1242
- [@&#8203;thinkofher](https://togithub.com/thinkofher) made their first
contribution in
[go-playground/validator#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>
renovate bot added a commit to nobl9/sloctl that referenced this pull request Jun 1, 2024
….0 (#130)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](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` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fgo-playground%2fvalidator%2fv10/v10.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fgo-playground%2fvalidator%2fv10/v10.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fgo-playground%2fvalidator%2fv10/v10.20.0/v10.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fgo-playground%2fvalidator%2fv10/v10.20.0/v10.21.0?slim=true)](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
[@&#8203;pixel365](https://togithub.com/pixel365) in
[go-playground/validator#1196
- change codes bool value to struct{} by
[@&#8203;nar10z](https://togithub.com/nar10z) in
[go-playground/validator#1270
- Fix grammar issues in comments, tests, field names by
[@&#8203;alexandear](https://togithub.com/alexandear) in
[go-playground/validator#1262
- Make docs for required more explicit regarding boolean values by
[@&#8203;alexongh](https://togithub.com/alexongh) in
[go-playground/validator#1261
- Fix Japanese translation of max-items, lt-items and lte-items error by
[@&#8203;Tomoki108](https://togithub.com/Tomoki108) in
[go-playground/validator#1250
- chore: fix some comments by
[@&#8203;pavedroad](https://togithub.com/pavedroad) in
[go-playground/validator#1242
- Polish language support by
[@&#8203;thinkofher](https://togithub.com/thinkofher) in
[go-playground/validator#1217

#### New Contributors

- [@&#8203;pixel365](https://togithub.com/pixel365) made their first
contribution in
[go-playground/validator#1196
- [@&#8203;nar10z](https://togithub.com/nar10z) made their first
contribution in
[go-playground/validator#1270
- [@&#8203;alexongh](https://togithub.com/alexongh) made their first
contribution in
[go-playground/validator#1261
- [@&#8203;Tomoki108](https://togithub.com/Tomoki108) made their first
contribution in
[go-playground/validator#1250
- [@&#8203;pavedroad](https://togithub.com/pavedroad) made their first
contribution in
[go-playground/validator#1242
- [@&#8203;thinkofher](https://togithub.com/thinkofher) made their first
contribution in
[go-playground/validator#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 pushed a commit to open-telemetry/opentelemetry-go-contrib that referenced this pull request Jun 3, 2024
…v10.21.0 (#5705)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](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` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fgo-playground%2fvalidator%2fv10/v10.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fgo-playground%2fvalidator%2fv10/v10.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fgo-playground%2fvalidator%2fv10/v10.20.0/v10.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fgo-playground%2fvalidator%2fv10/v10.20.0/v10.21.0?slim=true)](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
[@&#8203;pixel365](https://togithub.com/pixel365) in
[go-playground/validator#1196
- change codes bool value to struct{} by
[@&#8203;nar10z](https://togithub.com/nar10z) in
[go-playground/validator#1270
- Fix grammar issues in comments, tests, field names by
[@&#8203;alexandear](https://togithub.com/alexandear) in
[go-playground/validator#1262
- Make docs for required more explicit regarding boolean values by
[@&#8203;alexongh](https://togithub.com/alexongh) in
[go-playground/validator#1261
- Fix Japanese translation of max-items, lt-items and lte-items error by
[@&#8203;Tomoki108](https://togithub.com/Tomoki108) in
[go-playground/validator#1250
- chore: fix some comments by
[@&#8203;pavedroad](https://togithub.com/pavedroad) in
[go-playground/validator#1242
- Polish language support by
[@&#8203;thinkofher](https://togithub.com/thinkofher) in
[go-playground/validator#1217

#### New Contributors

- [@&#8203;pixel365](https://togithub.com/pixel365) made their first
contribution in
[go-playground/validator#1196
- [@&#8203;nar10z](https://togithub.com/nar10z) made their first
contribution in
[go-playground/validator#1270
- [@&#8203;alexongh](https://togithub.com/alexongh) made their first
contribution in
[go-playground/validator#1261
- [@&#8203;Tomoki108](https://togithub.com/Tomoki108) made their first
contribution in
[go-playground/validator#1250
- [@&#8203;pavedroad](https://togithub.com/pavedroad) made their first
contribution in
[go-playground/validator#1242
- [@&#8203;thinkofher](https://togithub.com/thinkofher) made their first
contribution in
[go-playground/validator#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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants