Add Kotlin to the runtime pages and move the server section there - #2198
Open
sherryfox wants to merge 1 commit into
Open
Add Kotlin to the runtime pages and move the server section there#2198sherryfox wants to merge 1 commit into
sherryfox wants to merge 1 commit into
Conversation
Follow-up to google#2191. The Kotlin quickstart had grown a loopback note and a "serve without the development UI" section; both were moved out of Getting Started in that PR, and this settles where they land. The blocker was that none of the three runtime pages mentioned Kotlin at all — no tab, and no entry in the support header — even though the web interface, the API server and the REPL have all shipped since v0.1.0. Kotlin becomes a participant on each page first, so the moved material has somewhere to sit. api-server.md gets a Kotlin tab under "Start the API server" and startup output under "Test locally". There is no separate "serve without the development UI" section: the tab already shows AdkApiServer, which is that, so a section under "Deploy your agent" would only repeat the snippet. The one fact it carried that the tab did not — a container has to set host, since the server binds 127.0.0.1 and Cloud Run cannot otherwise route to it — is now a line in the tab's note. web-interface/index.md gets tabs for starting the server, its output, and the AdkServerConfig properties that stand in for CLI flags. The loopback note is not carried over: what is unauthenticated is the REST API, which the interface is merely one client of, so a note about it on this page would describe the wrong thing. The page already warns against production use. command-line.md gets ReplRunner, and the transcript is taken from the string literals in ReplRunner.kt rather than adapted from another language's tab. Verified: every snippet compiles against the published 0.9.0 artifacts on JDK 17; the startup output in both server tabs was captured by running the servers, not adapted (AdkApiServer answered /list-apps, AdkDevServer redirected / to /dev-ui); and v0.1.0 in the support headers was confirmed by finding ReplRunner in the published 0.1.0 jar and the web UI in that release's notes. Not addressed here: the bundled Kotlin API reference is still generated at 0.5.0 and documents none of these classes, and the deploy pages have no Kotlin. Neither page carries guidance on exposing an unauthenticated API, which is worth its own change on api-server.md rather than a note on this one.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #2191. The Kotlin quickstart had grown a loopback note and a "serve without the development UI" section; both were moved out of Getting Started in that PR, and this settles where they land.
The blocker was that none of the three runtime pages mentioned Kotlin at all — no tab, and no entry in the support header — even though the web interface, the API server and the REPL have all shipped since v0.1.0. Kotlin becomes a participant on each page first, so the moved material has somewhere to sit.
api-server.md gets a Kotlin tab under "Start the API server" and startup output under "Test locally". There is no separate "serve without the development UI" section: the tab already shows AdkApiServer, which is that, so a section under "Deploy your agent" would only repeat the snippet. The one fact it carried that the tab did not — a container has to set host, since the server binds 127.0.0.1 and Cloud Run cannot otherwise route to it — is now a line in the tab's note.
web-interface/index.md gets tabs for starting the server, its output, and the AdkServerConfig properties that stand in for CLI flags. The loopback note is not carried over: what is unauthenticated is the REST API, which the interface is merely one client of, so a note about it on this page would describe the wrong thing. The page already warns against production use.
command-line.md gets ReplRunner, and the transcript is taken from the string literals in ReplRunner.kt rather than adapted from another language's tab.
Verified: every snippet compiles against the published 0.9.0 artifacts on JDK 17; the startup output in both server tabs was captured by running the servers, not adapted (AdkApiServer answered /list-apps, AdkDevServer redirected / to /dev-ui); and v0.1.0 in the support headers was confirmed by finding ReplRunner in the published 0.1.0 jar and the web UI in that release's notes.
Not addressed here: the bundled Kotlin API reference is still generated at 0.5.0 and documents none of these classes, and the deploy pages have no Kotlin. Neither page carries guidance on exposing an unauthenticated API, which is worth its own change on api-server.md rather than a note on this one.