fix(generator): include API version in client docs

[noahdietz]

Adds simple breadcrumb comment to client class commentary including the google.api.api_version value that this client was generated based on and sends in its requests, as per AIP-4236. This breadcrumb will allow client users to reference the API version used by the client in other API artifacts e.g. product documentation.

Fixes internal tracking bug http://b/467139856, child of http://b/467065424.

[gemini-code-assist]

Summary of Changes

Hello @noahdietz, I'm Gemini Code Assist¹! 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 significantly improves the generated client documentation by embedding the google.api.api_version directly into the client class commentary. This enhancement provides a clear and immediate reference for users to understand which API version a client was generated against and sends in its requests, thereby improving traceability and consistency across API artifacts and aligning with AIP-4236 guidelines.

Highlights

• API Version in Client Documentation: The pull request now includes the google.api.api_version value directly within the client class commentary in generated documentation.
• Enhanced User Reference: This addition allows client users to easily reference the specific API version used by the client, which can be crucial for aligning with other API artifacts and product documentation.
• AIP-4236 Compliance: The change is implemented in accordance with AIP-4236, ensuring adherence to Google's API design guidelines for versioning.

🧠 New Feature in Public Preview: You can now enable Memory 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 Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize 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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. 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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds the API version to the generated client documentation comments, which is a useful piece of information for users of the client library. The implementation looks mostly correct, but I have a suggestion to improve the formatting of the generated comment for better readability.

[noahdietz]

/gemini review

[gemini-code-assist]

Code Review

This pull request aims to include the API version in the generated client documentation, which is a helpful addition for users to reference. The implementation is straightforward, but I've found a minor formatting issue where an extra blank line is introduced in the generated comments. I've provided a suggestion to correct this, which should result in cleaner and more consistent documentation.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.95%. Comparing base (46f7e8b) to head (b0f0153).

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #15841      +/-   ##
==========================================
+ Coverage   92.94%   92.95%   +0.01%     
==========================================
  Files        2458     2458              
  Lines      227585   227588       +3     
==========================================
+ Hits       211531   211565      +34     
+ Misses      16054    16023      -31     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.