Repository navigation
chore: update ADK Java doc to version 1.11.0 - #2336
Conversation
✅ Deploy Preview for adk-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
joefernandez
left a comment
joefernandez
left a comment
There was a problem hiding this comment.
Content review report
- Review Score: 95
- Overall assessment: 🟡 Medium Risk
- Summary reasoning: This is a machine-generated Javadoc refresh to ADK Java 1.11.0, confined entirely to
docs/api-reference/java/**. It contains no legal language, no security/privacy claims, no monetary figures, no named customers, no personal information, and no internal Google links. The only items of note are the bulk deletion of 44 published pages without redirects, a pre-existing wrong copyright year on generated pages, and standard Javadoc deprecation notices that reference unspecified future releases. - Recommended action: Approve with no required changes. The one risk worth tracking is the 44 deleted pages becoming external 404s, since
redirect_mapsin mkdocs.yml L136 only maps.mdsources and cannot cover raw HTML; the deleted pages document sample agents that no longer exist upstream, so reader impact is small. Separately, theCopyright © 1980footer should be fixed in the Javadoc build config rather than in this PR. - Number of lines changed: XXL, 15386 (4348 added, 11038 removed)
- Number of files changed: 1107
🟡 Medium risk items
- 44 published pages are deleted with no redirects. Six sample packages disappear entirely:
com/example/adkdocs,adkprtriaging,adkspam,adkstale,adktriaging, andgithub. The removal is visible in element-list L1-L11. No page remaining in the tree links to any of them, so there is no internal link rot. The exposure is external: URLs such as.../com/example/github/GitHubTools.htmlbecome 404s, and theredirect_mapsblock at mkdocs.yml L136 maps only.mdsources, so raw HTML underapi-reference/java/**is not covered. These are generated Javadoc for sample agents that no longer exist upstream, so the practical loss is small. No change requested; flagged because bulk removal of existing content is a higher-risk pattern.
🟢 Low risk items
-
Copyright © 1980. All rights reserved.carries a wrong year and names no rights holder. It appears on the 4 new pages, for example RuntimeConfigController.html L199 and InMemorySessionService.DuplicateSessionIdBehavior.html L265. This is not introduced here: all 1,058 existing Javadoc pages already carry the identical string, and no diff hunk modifies an existing one (the diff only adds 4 copies on new files and removes 44 on deleted files). The 1980 date is the reproducible-build zip epoch leaking into the footer. A suggestion block is not useful because the fix belongs in the Javadoc build (-bottomflag, or the POM'smaven-javadoc-plugin<bottom>), not in generated output. Worth filing separately so the next regeneration emitsCopyright © 2026 Google LLC. All rights reserved. -
Forward-looking statements about unreleased behavior. Three deprecation notes commit to future product changes: "Rejects the call with
SessionException. Becomes the default in a future release" at InMemorySessionService.DuplicateSessionIdBehavior.html L210, plus matching text at L139 and L199. Similar wording appears onResumabilityConfig.isPlainTextContinuationAutoResume()("this flag will be removed") at ResumabilityConfig.html L166. These are standard Javadoc deprecation notices mirrored from the ADK Java source; they name no release number and no date, and describe intent rather than promising a schedule. Acceptable as written. -
Change volume is XXL and not reviewable line by line. 15,386 lines across 1,107 files. Mitigated by the change being wholly machine-generated and confined to one directory: the version-string replacement is uniform, and the structural edits trace to real upstream API additions (
InMemorySessionService.DuplicateSessionIdBehavior,BackendUrl,RuntimeConfigController).
| @@ -1,11 +1,5 @@ | |||
| com.example | |||
| com.example.a2a_basic | |||
There was a problem hiding this comment.
L0 RISK REVIEW (Medium): This hunk drops six packages, deleting 44 published pages with no redirect. URLs such as .../com/example/github/GitHubTools.html become external 404s — the redirect_maps block at mkdocs.yml L136 maps only .md sources, so raw HTML under api-reference/java/** is not covered.
No internal link rot: nothing left in the tree links to these packages, and they document sample agents that no longer exist upstream. No suggestion offered because the deletions are correct — the gap is redirect coverage for generated HTML, which belongs in the site config, not here.
| <!-- ========= END OF CLASS DATA ========= --> | ||
| <footer> | ||
| <hr> | ||
| <p class="legal-copy"><small>Copyright © 1980. All rights reserved.</small></p> |
There was a problem hiding this comment.
L0 RISK REVIEW (Low): The footer reads Copyright © 1980. All rights reserved. — wrong year and no rights holder named. 1980 is the reproducible-build zip epoch leaking into the Javadoc footer.
Not introduced by this PR: all 1,058 existing Javadoc pages carry the identical string and no hunk modifies an existing one. No suggestion block, because editing generated HTML would be overwritten on the next regeneration — the fix belongs in the Javadoc build (-bottom, or the POM's maven-javadoc-plugin <bottom>) so it emits Copyright © 2026 Google LLC. All rights reserved. Worth filing separately.
| <h3>REJECT</h3> | ||
| <div class="horizontal-scroll"> | ||
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="InMemorySessionService.DuplicateSessionIdBehavior.html" title="enum class in com.google.adk.sessions">InMemorySessionService.DuplicateSessionIdBehavior</a></span> <span class="element-name">REJECT</span></div> | ||
| <div class="block">Rejects the call with <a href="SessionException.html" title="class in com.google.adk.sessions"><code>SessionException</code></a>. Becomes the default in a future release.</div> |
There was a problem hiding this comment.
L0 RISK REVIEW (Low): Forward-looking statement about unreleased behavior — "Becomes the default in a future release", with matching text at L139 and L199.
Acceptable as written: it is a standard Javadoc deprecation notice mirrored from the ADK Java source, naming no release number and no date. Flagged for the record only — no change requested, since any rewording has to happen in the upstream source comment rather than in generated output.
KevinACheek
left a comment
KevinACheek
left a comment
There was a problem hiding this comment.
Only comment. do we need to provide redirects for the 44 removed files?
Thanks for checking on that! |
2 participants
Regenerates the Java API reference (Javadoc) from the ADK Java v1.11.0 release. The in-repo assets were on 1.10.1.
bash tools/java-api-docs/generate.sh 1.11.0docs/api-reference/java/index.htmlnow rendersMaven Parent POM 1.11.0 APIcom/example/adkdocs,adkprtriaging,adkspam,adkstale,adktriagingandgithubsample packages: those sources no longer exist upstream atv1.11.0Rendered page: https://adk.dev/api-reference/java/
Upstream release: https://github.com/google/adk-java/releases/tag/v1.11.0 (v1.11.0)
No dependency-version PR accompanies this one: the hardcoded
com.google.adk:google-adkcoordinates and<google-adk.version>values indocs/**/*.mdandexamples/java/**/pom.xmlare already at 1.11.0 from #2297.