docs(openapi): enhance OpenAPI docs for session and system endpoints#5028
Draft
akshay-kumar-bm wants to merge 6 commits intogoogle:mainfrom
Draft
docs(openapi): enhance OpenAPI docs for session and system endpoints#5028akshay-kumar-bm wants to merge 6 commits intogoogle:mainfrom
akshay-kumar-bm wants to merge 6 commits intogoogle:mainfrom
Conversation
Agent-Logs-Url: https://github.com/akshay-kumar-bm/adk-python/sessions/d4c41219-6a86-4329-9540-432d55c7def7 Co-authored-by: akshay-kumar-bm <90820098+akshay-kumar-bm@users.noreply.github.com>
…ydantic-models docs: improve OpenAPI documentation for session management endpoints
…tions and examples
…dpoints with detailed descriptions and error handling
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
adk-bot
added
the
documentation
Collaborator
|
Response from ADK Triaging Agent Hello @akshay-kumar-bm, thank you for your contribution! To help reviewers better understand the improvements to the OpenAPI documentation, could you please provide a screenshot of the generated docs after your changes have been applied? This will help to verify the visual and descriptive enhancements you've made. Thanks! |
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
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.
Description
This PR improves the generated OpenAPI documentation for the ADK Web Server API by adding clearer endpoint metadata and richer schema docs (descriptions + examples) for session- and run-related request/response models.
What changed
Field(...)descriptions/examples to request models used by the web server API (e.g.,RunAgentRequest,CreateSessionRequest,UpdateSessionRequest) insrc/google/adk/cli/adk_web_server.py.summary,response_description,responses, and more detailed docstrings), including system endpoints like/healthand a debug endpoint for event graphs.Field(...)descriptions/examples for the coreSessionmodel insrc/google/adk/sessions/session.py.Why
The OpenAPI output was technically correct but lacked enough context (field meanings, examples, and expected error cases) for consumers using Swagger UI / generated clients.
Issue
Testing
Documentation-only change (OpenAPI metadata / schema docs).
Checklist
CONTRIBUTING.md.