Repository navigation
Update API Server Docs for all available endpoints #2511
Description
Hi, the endpoints available at /docs are not fully explained in the docs at https://google.github.io/adk-docs/get-started/testing/#local-testing
Would be great if the REST API has its own doc section "REST API Reference"
Activity
klateefa commentedon Nov 24, 2025
@metalshanked Thank you for reporting this. I understand the request is currently under review. Please keep me posted if anything else is needed. Thanks for your patience.
polong-lin commentedon Feb 23, 2026
@boyangsvl Do you know if we have docs for the REST API that we could publish into ADK docs?
Currently in ADK docs, we have this page, but it's sparse:
https://google.github.io/adk-docs/api-reference/rest/
boyangsvl commentedon Feb 23, 2026
I thought we have a comprehensive list of API endpoint docs. @wyf7107 do you remember?
If not, we should have one. Or maybe just post the doc generated by the api server.
akshay-kumar-lly commentedon Mar 25, 2026
I'd like to help write the REST API reference docs. I can start by documenting the existing endpoints from the FastAPI server — happy to draft a PR.
akshay-kumar-lly commentedon Mar 25, 2026
I've submitted a PR to adk-docs covering all 40 endpoints: google/adk-docs#1494
Let me know if you'd like any changes before review.
cc @polong-lin @boyangsvl
koverholt commentedon Mar 27, 2026
Opened a new PR in adk-docs (google/adk-docs#1500) that replaces the hand-written REST API reference with auto-generated Swagger UI from the FastAPI OpenAPI spec. It covers all 40+ API server endpoints with full request/response schemas.
If folks want to help improve the generated REST API docs further, adding
Field(description=...)and examples to the Pydantic models, and docstrings andresponsesto the route handlers in this repo would be great! Those will flow through to the generated docs automatically after google/adk-docs#1500 is merged.akshay-kumar-bm commentedon Mar 27, 2026
Thanks for the auto-generated docs—this is really helpful!
I'd like to contribute by improving the generated API docs (adding descriptions, examples, and better docstrings in the FastAPI code).
I can start working on this and raise a PR. Please let me know if that works or if there’s anything specific I should prioritize.
koverholt commentedon Mar 27, 2026
google/adk-docs#1500 is merged and new generated REST API docs are now shown at https://google.github.io/adk-docs/api-reference/rest/.
akshay-kumar-bm commentedon Mar 27, 2026
@koverholt
I have raised a PR for updating the default section in FastAPI, including descriptions and API documentation. I also added field descriptions for the default section endpoint.
Could you please review it and share your feedback? Based on your feedback, I will complete the remaining endpoints.
PR: #5029
(Also facing an issue — it’s showing “Missing CLA” even though I’ve already gone through the process.)
koverholt commentedon Mar 27, 2026
@akshay-kumar-bm, thanks! I'll have to defer to the adk-python team for their intake process and review. And the CLA check is failing because the commits in that PR/branch were coauthored by Copilot, which might affect the mergeability and review process.
akshay-kumar-bm commentedon Mar 27, 2026
I have re-raised the PR to fix the CLA check issue that was blocking the merge. Requesting review and feedback #5031