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

chore(kuma-cp) annotate required fields in protos #2556

Conversation

bartsmykla
Copy link
Contributor

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

  • Unit tests
  • E2E tests
  • Manual testing on Universal
  • Manual testing on Kubernetes

Backwards compatibility

  • Add backport-to-stable label if the code is backwards compatible. Otherwise, list breaking changes.

These fields will be used to mark fields as required in our docs
when generated

Signed-off-by: Bart Smykla <bartek@smykla.com>
@bartsmykla bartsmykla requested a review from a team as a code owner August 12, 2021 12:00
@jpeach
Copy link
Contributor

jpeach commented Aug 16, 2021

How do we keep this in sync with the actual validation code?

@bartsmykla
Copy link
Contributor Author

@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-commenter
Copy link

codecov-commenter commented Aug 16, 2021

Codecov Report

Merging #2556 (40189e9) into master (19f4803) will increase coverage by 0.02%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            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              
Impacted Files Coverage Δ
api/mesh/v1alpha1/circuit_breaker.pb.go 46.08% <ø> (ø)
api/mesh/v1alpha1/externalservice.pb.go 53.54% <ø> (ø)
api/mesh/v1alpha1/fault_injection.pb.go 47.29% <ø> (ø)
api/mesh/v1alpha1/health_check.pb.go 30.54% <ø> (ø)
api/mesh/v1alpha1/proxy_template.pb.go 33.37% <ø> (ø)
api/mesh/v1alpha1/rate_limit.pb.go 46.84% <ø> (ø)
api/mesh/v1alpha1/retry.pb.go 33.91% <ø> (ø)
api/mesh/v1alpha1/timeout.pb.go 42.79% <ø> (ø)
api/mesh/v1alpha1/traffic_log.pb.go 53.39% <ø> (ø)
api/mesh/v1alpha1/traffic_permission.pb.go 56.06% <ø> (ø)
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 19f4803...40189e9. Read the comment docs.

@jpeach
Copy link
Contributor

jpeach commented Aug 18, 2021

@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

Yeh we could look at protoc-gen-validate again I suppose 🤷

Signed-off-by: Bart Smykla <bartek@smykla.com>
Copy link
Contributor

@jpeach jpeach left a 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 :)

@bartsmykla bartsmykla merged commit 58b822f into kumahq:master Aug 24, 2021
@bartsmykla bartsmykla deleted the chore/annotate-required-fields-in-api-protos branch August 24, 2021 06:01
mergify bot pushed a commit that referenced this pull request Aug 24, 2021
* 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)
bartsmykla added a commit that referenced this pull request Aug 24, 2021
* 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>
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.

3 participants