docs: Document Fn Execution API protos#39293
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #39293 +/- ##
============================================
- Coverage 58.73% 58.70% -0.03%
Complexity 7418 7418
============================================
Files 1649 1649
Lines 212369 212787 +418
Branches 6330 6330
============================================
+ Hits 124727 124926 +199
- Misses 83095 83314 +219
Partials 4547 4547
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Add documentation comments to previously undocumented messages and fields in the Beam Fn API protos: beam_fn_api.proto: ProcessBundleResponse, ProcessBundleProgressResponse, FinalizeBundleRequest/Response, Elements.DrainMode, StateRequest/Response, BeamFnState service, StateKey, StateAppendResponse, StateClearRequest/Response, OrderedListRange, LogControl, StartWorkerRequest/Response, StopWorkerRequest/Response, BeamFnExternalWorkerPool service. beam_provision_api.proto: Consistency fix on dependencies field.
b060284 to
1c7efa5
Compare
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the maintainability and understandability of the Beam Fn API by adding descriptive documentation comments to the existing protobuf definitions. These changes are strictly limited to documentation and do not alter the underlying code, field numbers, or data structures, ensuring full backward compatibility. Highlights
New Features🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request adds comprehensive documentation and comments to various Protobuf messages, fields, and services within the Beam Fn API (beam_fn_api.proto) and the Provision API (beam_provision_api.proto). These additions clarify the roles of requests, responses, and services like worker management, state APIs, and bundle processing. There are no review comments, so I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
Assigning reviewers: R: @tvalentyn added as fallback since no labels match configuration Note: If you would like to opt out of this review, comment Available commands:
The PR bot will only process comments in the main thread (not review comments). |
Description
Add documentation comments to previously undocumented messages, fields, and enums in the Beam Fn API protos, which define the gRPC interface between the SDK harness and runner harness.
Files Changed
beam_fn_api.protobeam_provision_api.protoNotes