Swap validator for garde
#1212
Merged
Swap validator for garde
#1212
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
The validator crate used in the derive docs and in the crd example is no longer actively maintained. It has been superseded by garde which offers similar functionality. This change replaces validator with garde in dev dependencies (and in the crd_api example dependency). Although garde has the same derive macro, its attribute differs from validator, and it additionally requires fields to be explictly skipped from validation, and does not offer a built-in way to validate required fields. Changes have been made to the kube_derive crate's docs to both replace existing mentions of validator, and inform on the caveats mentioned above. Signed-off-by: Matei David <matei.david.35@gmail.com>
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #1212 +/- ##
==========================================
- Coverage 73.49% 73.45% -0.04%
==========================================
Files 68 68
Lines 5349 5341 -8
==========================================
- Hits 3931 3923 -8
Misses 1418 1418
|
Signed-off-by: Matei David <matei.david.35@gmail.com>
clux
reviewed
Apr 29, 2023
There was a problem hiding this comment.
Thanks for taking the time to dig into this. I think that given how clearly this ends up separating client-side and server-side validation, i think we should take garde out of our dev-dependencies and leave it as an example trick, but the docs are good. Left one bigger reword.
clux
reviewed
Apr 29, 2023
Signed-off-by: Matei David <matei.david.35@gmail.com>
Signed-off-by: Matei David <matei.david.35@gmail.com>
Co-authored-by: Eirik A <sszynrae@gmail.com> Signed-off-by: Matei David <matei.david.35@gmail.com>
Signed-off-by: Matei David <matei.david.35@gmail.com>
…be into matei/swap-validation-lib
Signed-off-by: Matei David <matei.david.35@gmail.com>
|
@clux thanks for the review! I made a few changes:
Lmk how it looks, happy to finesse this more :) |
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.
Motivation
The validator crate used in the derive docs and in the crd example is no longer actively maintained. It has been superseded by garde which offers similar functionality.
Fixes #1197 (check issue for additional context)
Solution
This change replaces validator with garde in dev dependencies (and in the crd_api example dependency). Although garde has the same derive macro, its attribute differs from validator, and it additionally requires fields to be explictly skipped from validation, and does not offer a built-in way to validate required fields.
Changes have been made to the kube_derive crate's docs to both replace existing mentions of validator, and inform on the caveats mentioned above.