-
Notifications
You must be signed in to change notification settings - Fork 335
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
chore(kuma-cp) annotate required fields in protos #2556
chore(kuma-cp) annotate required fields in protos #2556
Conversation
These fields will be used to mark fields as required in our docs when generated Signed-off-by: Bart Smykla <bartek@smykla.com>
How do we keep this in sync with the actual validation code? |
@jpeach without automating generation of validators I don't think it will be easy, so probably currently doing it manually will have to be sufficient, or we have to take time to automate validators |
Signed-off-by: Bart Smykla <bartek@smykla.com>
Signed-off-by: Bart Smykla <bartek@smykla.com>
Codecov Report
@@ Coverage Diff @@
## master #2556 +/- ##
==========================================
+ Coverage 52.21% 52.23% +0.02%
==========================================
Files 869 869
Lines 48565 48565
==========================================
+ Hits 25357 25367 +10
+ Misses 21162 21152 -10
Partials 2046 2046
Continue to review full report at Codecov.
|
Yeh we could look at protoc-gen-validate again I suppose 🤷 |
…equired-fields-in-api-protos
Signed-off-by: Bart Smykla <bartek@smykla.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks reasonable to me, with the caveat that I didn't double-check everything against the code :)
* chore(kuma-cp) annotate required fields in protos These fields will be used to mark fields as required in our docs when generated Signed-off-by: Bart Smykla <bartek@smykla.com> (cherry picked from commit 58b822f)
* chore(kuma-cp) annotate required fields in protos These fields will be used to mark fields as required in our docs when generated Signed-off-by: Bart Smykla <bartek@smykla.com> (cherry picked from commit 58b822f) Co-authored-by: Bart Smykla <bartek@smykla.com>
Summary
These fields will be used to mark fields as required in our docs
when generated
Issues resolved
No issue
Documentation
No documentation changes
Testing
Backwards compatibility
backport-to-stable
label if the code is backwards compatible. Otherwise, list breaking changes.