Repository navigation
docs(openapi): improve docs for session model and default session endpoints - #5031
Closed
akshay-kumar-bm wants to merge 2 commits into
Closed
akshay-kumar-bm wants to merge 2 commits into
akshay-kumar-bm wants to merge 2 commits into
Conversation
Contributor
Author
|
Here some screenshort compare origin and updateing doc 
|
adk-bot
added
the
documentation
This was referenced Mar 27, 2026
rohityan
added
web
rohityan
reviewed
Mar 30, 2026
| @@ -1076,10 +1215,47 @@ async def get_session_trace(session_id: str) -> Any: | |||
| @app.get( | |||
| "/apps/{app_name}/users/{user_id}/sessions/{session_id}", | |||
Collaborator
There was a problem hiding this comment.
having a tags=["Sessions"] would be helpful.
Collaborator
|
Hi @akshay-kumar-bm , Thank you for your contribution! We appreciate you taking the time to submit this pull request. Please fix formatting errors by running autoformat.sh. Also please address the review comments. |
rohityan
added
the
request clarification
Contributor
Author
|
Thanks for the feedback and for taking the time to review this PR @rohityan . I added |
Contributor
Author
|
Here screenshot few screenshort |
2 of 4 tasks
Contributor
Author
|
Hi @rohityan — just checking in on this. I addressed the |
akshay-kumar-bm
force-pushed
the
docs/openapi-session-endpoint-docs-update
branch
from
May 16, 2026 13:25
8f28af0 to
311869f
Compare
akshay-kumar-bm
force-pushed
the
docs/openapi-session-endpoint-docs-update
branch
from
May 21, 2026 05:40
311869f to
04ea27e
Compare
copybara-service Bot
pushed a commit
that referenced
this pull request
Jun 16, 2026
Merge #5031 ### Description This PR improves the generated OpenAPI/Swagger documentation for session management by adding clearer metadata and richer schema docs for the Session model (descriptions + examples). ### What changed - Session model docs: add field descriptions/examples for so the API schema is self-explanatory. ### Why The OpenAPI output was correct but lacked enough context (field meanings and examples) for users reading Swagger UI or generating clients. ### Testing Documentation-only change (OpenAPI metadata / schema docs). - Unit tests: Not run. Co-authored-by: Shangjie Chen <deanchen@google.com> COPYBARA_INTEGRATE_REVIEW=#5031 from akshay-kumar-bm:docs/openapi-session-endpoint-docs-update 04ea27e PiperOrigin-RevId: 932788042
Collaborator
|
Thank you @akshay-kumar-bm for your contribution! 🎉 Your changes have been successfully imported and merged via Copybara in commit 7a11b50. Closing this PR as the changes are now in the main branch. |
FrigaZzz
pushed a commit
to FrigaZzz/adk-python
that referenced
this pull request
Aug 11, 2026
Merge google#5031 ### Description This PR improves the generated OpenAPI/Swagger documentation for session management by adding clearer metadata and richer schema docs for the Session model (descriptions + examples). ### What changed - Session model docs: add field descriptions/examples for so the API schema is self-explanatory. ### Why The OpenAPI output was correct but lacked enough context (field meanings and examples) for users reading Swagger UI or generating clients. ### Testing Documentation-only change (OpenAPI metadata / schema docs). - Unit tests: Not run. Co-authored-by: Shangjie Chen <deanchen@google.com> COPYBARA_INTEGRATE_REVIEW=google#5031 from akshay-kumar-bm:docs/openapi-session-endpoint-docs-update 04ea27e PiperOrigin-RevId: 932788042
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/Swagger documentation for session
management by adding clearer endpoint metadata and richer schema docs
(descriptions + examples).
What changed
Sessionso the APIschema is self-explanatory.
management routes (create/get/list/update/delete sessions + events/artifacts
where applicable) so request/response shapes and common errors are clearer.
/health,/ version,and
/list-apps(where present in this server), including clearer summariesand error notes.
Why
The OpenAPI output was correct but lacked enough context (field meanings,
examples, and expected error cases) for users reading Swagger UI or generating
clients.
Testing
Documentation-only change (OpenAPI metadata / schema docs).
session-related schemas and endpoints.
Notes
chore: rerun CI) to re-trigger GitHub Actionswithout changing code.
Checklist
CONTRIBUTING.md.