FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

fix: add api_version breadcrumb to client docs by noahdietz · Pull Request #4018 · googleapis/sdk-platform-java · GitHub

This repository was archived by the owner on May 14, 2026. It is now read-only.
/ sdk-platform-java Public archive

fix: add api_version breadcrumb to client docs - #4018

Merged
blakeli0 merged 7 commits into
googleapis:mainfrom
noahdietz:api-version-client-docs
Dec 12, 2025
ConversationCommits (7)ChecksFiles changed
Merged

fix: add api_version breadcrumb to client docs#4018
blakeli0 merged 7 commits into
googleapis:mainfrom
noahdietz:api-version-client-docs

Conversation

noahdietz commented Dec 11, 2025

Copy link
Copy Markdown
Contributor

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/467138606, child of http://b/467065424.

product-auto-label Bot added the size: s Pull request size is small. label Dec 11, 2025

gemini-code-assist Bot commented Dec 11, 2025

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @noahdietz, 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 introduces a significant enhancement to the generated client documentation by embedding the google.api.api_version directly into the client class commentary. This "breadcrumb" comment provides immediate visibility into the API version a client was generated against and uses in its requests, thereby improving traceability and alignment with AIP-4236 for better product documentation and user understanding.

Highlights

  • API Version Breadcrumb: Adds the google.api.api_version as a breadcrumb comment directly into the client class documentation.
  • AIP-4236 Compliance: Implements this documentation enhancement in accordance with the guidelines of AIP-4236.
  • Improved Referencing: Enables client users to easily reference the specific API version used by the client in other product documentation or artifacts.
  • Internal Bug Fix: Addresses and fixes internal tracking bugs http://b/467138606 and http://b/467065424.
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 Bot reviewed Dec 11, 2025
View reviewed changes

gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Code Review

This pull request adds an API version breadcrumb to the generated client documentation, as specified by AIP-4236. The implementation correctly appends the version information to the service description. However, I've identified a couple of areas for improvement to ensure full compliance with the AIP and to handle edge cases gracefully. My feedback includes a suggestion to correctly format the breadcrumb when the API short name is missing, and another to ensure the breadcrumb is always included when an API version is present, regardless of whether a service description exists.

Comment thread .../main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java
Comment thread .../main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java Outdated
noahdietz marked this pull request as ready for review December 11, 2025 21:46
noahdietz requested review from blakeli0 and lqiu96 December 11, 2025 21:47
blakeli0 approved these changes Dec 11, 2025
View reviewed changes

blakeli0 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks Noah!

noahdietz removed the request for review from lqiu96 December 11, 2025 22:18

noahdietz commented Dec 11, 2025

Copy link
Copy Markdown
Contributor Author

Thanks Noah!

You're welcome, thanks for the quick review!

noahdietz commented Dec 11, 2025

Copy link
Copy Markdown
Contributor Author

@blakeli0 I assume I can ignore the two failing presubmits?

blakeli0 commented Dec 11, 2025

Copy link
Copy Markdown
Contributor

@blakeli0 I assume I can ignore the two failing presubmits?

Yes, those are fine. FYI, we are in the middle of testing RCs, we'll merge this PR once the testing are done.

noahdietz commented Dec 11, 2025

Copy link
Copy Markdown
Contributor Author

Yes, those are fine. FYI, we are in the middle of testing RCs, we'll merge this PR once the testing are done.

Ok great thanks for letting me know! I do have the power to push the button it seems so I wasn't sure if I should do it myself or not. I will leave it to you!

Cheers.

blakeli0 merged commit a2b2179 into googleapis:main Dec 12, 2025
52 of 54 checks passed
release-please Bot mentioned this pull request Dec 12, 2025
Closed
release-please Bot mentioned this pull request Jan 12, 2026
Merged
diegomarquezp pushed a commit that referenced this pull request Jan 13, 2026
chore(main): release 2.65.0 (#4058)
972f87a 
🤖 I have created a release *beep* *boop*
---


<details><summary>2.65.0</summary>

##
[2.65.0](v2.64.2...v2.65.0)
(2026-01-12)


### Features

* add org.json:json to third-party-dependencies pom
([#4047](#4047))
([ffa432e](ffa432e)),
closes
[#4046](#4046)
* remove dependency management of graal-sdk
([#4033](#4033))
([ad05c34](ad05c34))


### Bug Fixes

* add api_version breadcrumb to client docs
([#4018](#4018))
([a2b2179](a2b2179))
* Create a single S2AChannelCredentials per application
([#3989](#3989))
([3758b43](3758b43))
* provide API to share the same background executor for channel po…
([#4030](#4030))
([178182c](178182c))


### Dependencies

* update dependencies.txt for grpc-gcp to 1.9.0
([#4025](#4025))
([b68791d](b68791d))
* update google api dependencies
([#3917](#3917))
([480cf13](480cf13))
* update google.http-client.version to 2.0.3
([#4054](#4054))
([b9a8c89](b9a8c89))


### Documentation

* Fix retry guide link in javadocs
([#4029](#4029))
([b43f77c](b43f77c))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
diegomarquezp pushed a commit that referenced this pull request Jan 21, 2026
chore(main): release 2.65.0 (#4058)
5218acb 
🤖 I have created a release *beep* *boop*
---


<details><summary>2.65.0</summary>

##
[2.65.0](v2.64.2...v2.65.0)
(2026-01-12)


### Features

* add org.json:json to third-party-dependencies pom
([#4047](#4047))
([ffa432e](ffa432e)),
closes
[#4046](#4046)
* remove dependency management of graal-sdk
([#4033](#4033))
([ad05c34](ad05c34))


### Bug Fixes

* add api_version breadcrumb to client docs
([#4018](#4018))
([a2b2179](a2b2179))
* Create a single S2AChannelCredentials per application
([#3989](#3989))
([3758b43](3758b43))
* provide API to share the same background executor for channel po…
([#4030](#4030))
([178182c](178182c))


### Dependencies

* update dependencies.txt for grpc-gcp to 1.9.0
([#4025](#4025))
([b68791d](b68791d))
* update google api dependencies
([#3917](#3917))
([480cf13](480cf13))
* update google.http-client.version to 2.0.3
([#4054](#4054))
([b9a8c89](b9a8c89))


### Documentation

* Fix retry guide link in javadocs
([#4029](#4029))
([b43f77c](b43f77c))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
lqiu96 pushed a commit that referenced this pull request Feb 12, 2026
fix: add api_version breadcrumb to client docs (#4018)
a7c66b6 
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/467138606, child of
http://b/467065424.
lqiu96 pushed a commit that referenced this pull request Feb 12, 2026
chore(main): release 2.65.0 (#4058)
b4704f8 
🤖 I have created a release *beep* *boop*
---


<details><summary>2.65.0</summary>

##
[2.65.0](v2.64.2...v2.65.0)
(2026-01-12)


### Features

* add org.json:json to third-party-dependencies pom
([#4047](#4047))
([ffa432e](ffa432e)),
closes
[#4046](#4046)
* remove dependency management of graal-sdk
([#4033](#4033))
([ad05c34](ad05c34))


### Bug Fixes

* add api_version breadcrumb to client docs
([#4018](#4018))
([a2b2179](a2b2179))
* Create a single S2AChannelCredentials per application
([#3989](#3989))
([3758b43](3758b43))
* provide API to share the same background executor for channel po…
([#4030](#4030))
([178182c](178182c))


### Dependencies

* update dependencies.txt for grpc-gcp to 1.9.0
([#4025](#4025))
([b68791d](b68791d))
* update google api dependencies
([#3917](#3917))
([480cf13](480cf13))
* update google.http-client.version to 2.0.3
([#4054](#4054))
([b9a8c89](b9a8c89))


### Documentation

* Fix retry guide link in javadocs
([#4029](#4029))
([b43f77c](b43f77c))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
chingor13 pushed a commit to googleapis/google-cloud-java that referenced this pull request Mar 24, 2026
chore(main): release 2.65.0 (#4058)
0d09c8a 
🤖 I have created a release *beep* *boop*
---


<details><summary>2.65.0</summary>

##
[2.65.0](googleapis/sdk-platform-java@v2.64.2...v2.65.0)
(2026-01-12)


### Features

* add org.json:json to third-party-dependencies pom
([#4047](googleapis/sdk-platform-java#4047))
([5898abd](googleapis/sdk-platform-java@5898abd)),
closes
[#4046](googleapis/sdk-platform-java#4046)
* remove dependency management of graal-sdk
([#4033](googleapis/sdk-platform-java#4033))
([09ec2a3](googleapis/sdk-platform-java@09ec2a3))


### Bug Fixes

* add api_version breadcrumb to client docs
([#4018](googleapis/sdk-platform-java#4018))
([0573232](googleapis/sdk-platform-java@0573232))
* Create a single S2AChannelCredentials per application
([#3989](googleapis/sdk-platform-java#3989))
([6a24164](googleapis/sdk-platform-java@6a24164))
* provide API to share the same background executor for channel po…
([#4030](googleapis/sdk-platform-java#4030))
([051f76a](googleapis/sdk-platform-java@051f76a))


### Dependencies

* update dependencies.txt for grpc-gcp to 1.9.0
([#4025](googleapis/sdk-platform-java#4025))
([2376f6c](googleapis/sdk-platform-java@2376f6c))
* update google api dependencies
([#3917](googleapis/sdk-platform-java#3917))
([bf94a0a](googleapis/sdk-platform-java@bf94a0a))
* update google.http-client.version to 2.0.3
([#4054](googleapis/sdk-platform-java#4054))
([343a8ef](googleapis/sdk-platform-java@343a8ef))


### Documentation

* Fix retry guide link in javadocs
([#4029](googleapis/sdk-platform-java#4029))
([4bb3ccc](googleapis/sdk-platform-java@4bb3ccc))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

2 more reviewers
gemini-code-assist[bot] gemini-code-assist[bot] left review comments
blakeli0 blakeli0 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

size: s Pull request size is small.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL