fix(proto): generate openapi for v2 api with gnostic#4847
Conversation
|
The latest Buf updates on your PR. Results from workflow Proto / proto-lint (pull_request).
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## v2 #4847 +/- ##
==========================================
+ Coverage 58.11% 58.57% +0.46%
==========================================
Files 135 135
Lines 16843 16843
==========================================
+ Hits 9788 9866 +78
+ Misses 6375 6292 -83
- Partials 680 685 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
d8d71d9 to
8358e4e
Compare
dosubot
Bot
added
the
size:XXL
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the environments service API by adding comprehensive OpenAPI documentation, improving protobuf message definitions, and updating build tooling. The changes focus on better documenting existing endpoints and removing problematic wildcard path patterns from the resource API.
- Added extensive OpenAPI documentation for all environment service endpoints including summaries and parameter descriptions
- Removed confusing resource endpoints with wildcard path patterns and consolidated them into cleaner, more specific paths
- Added detailed comments to protobuf messages and fields for better code documentation
Reviewed Changes
Copilot reviewed 16 out of 17 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| rpc/v2/environments/openapi.yaml | Added comprehensive OpenAPI documentation including endpoint summaries, parameter descriptions, and schema documentation |
| rpc/v2/environments/environments.proto | Enhanced protobuf definitions with extensive comments and OpenAPI annotations |
| rpc/v2/environments/environments.pb.go | Generated protobuf Go code reflecting the enhanced documentation |
| rpc/v2/environments/environments.pb.gw.go | Updated gRPC gateway code with corrected path patterns |
| magefile.go | Improved build tooling for protobuf generation |
| internal/cmd/protoc-gen-go-flipt-sdk/go.mod | Added dependency for flipt RPC package |
| rpc/v2/evaluation/evaluation.pb.go | Updated protoc-gen-go version |
| rpc/v2/analytics/analytics.pb.go | Updated protoc-gen-go version |
| rpc/flipt/*/*.pb.go | Updated protoc-gen-go version across all flipt packages |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
erka
changed the title
|
Related Documentation Checked 4 published document(s). No updates required. You have 1 draft document(s). Publish docs to keep them always up-to-date How did I do? Any feedback? |
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 17 out of 18 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (1)
rpc/v2/environments/openapi.yaml:1
- The comment says 'The list of namespaces' but this field contains a single namespace, not a list. The comment should be 'The namespace' instead.
# Generated with protoc-gen-openapi
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Signed-off-by: Roman Dmytrenko <[email protected]>
Co-authored-by: Copilot <[email protected]> Signed-off-by: Roman Dmytrenko <[email protected]>
Co-authored-by: Copilot <[email protected]> Signed-off-by: Roman Dmytrenko <[email protected]>
Signed-off-by: Roman Dmytrenko <[email protected]>
|
@markphelps I propose this over #4846 |
markphelps
left a comment
markphelps
left a comment
There was a problem hiding this comment.
looks great thank you!
|
Documentation Updates Checked 4 published document(s). No updates required. You have 1 draft document(s). Publish docs to keep them always up-to-date How did I do? Any feedback? |
This pull request introduces several improvements and enhancements to the Flipt gRPC/protobuf API, especially for the environments service, as well as some build and tooling changes. The most notable updates are the addition of new messages and fields to support richer environment and namespace management, improvements to the proto generation process, and dependency/version updates.