Promote google.adk.cli.fast_api.get_fast_api_app to public namespace#4560
Promote google.adk.cli.fast_api.get_fast_api_app to public namespace#4560olliefr wants to merge 18 commits intogoogle:mainfrom
google.adk.cli.fast_api.get_fast_api_app to public namespace#4560Conversation
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
|
Hi @olliefr , Thank you for your contribution! We appreciate you taking the time to submit this pull request. |
|
Closes #4500 (as per google/adk-docs#1335) |
|
Hi @xuanyang15 , can you please review this. LGTM |
|
@ryanaiagent and @xuanyang15, I did everything that was asked of me. Can this be reviewed and merged, please? |
|
Hi, @rohityan and @xuanyang15. Can this be reviewed and merged, please? It's a simple fix that concerns an unfortunate omission from the important section of the developer documentation. If the changes in this PR are not sufficient to address the issue, please advise on how best to proceed with remediation. This is for the benefit of every developer who would like to promote their ADK agents to production use. |
|
Hi @olliefr, Thanks for creating this PR! It is already under internal review, there were some discussions about how we manage the interface and api reference for the cli module. I will ping the stakeholders to expedite the decision. |
Link to Issue or Description of Change
Link to an existing issue:
Problem:
As described in the aforementioned issue, a method from one of the ADK modules is being used in multiple places in the official ADK documentation yet there is no API Reference docs generated for it at the moment.
Solution:
I'm simply following the plan devised by @klateefa as detailed in the aforementioned issue.
This is my first PR to the ADK repo so help is welcome.
My understanding is that once this PR is merged, the API Reference docs can be regenerated and then they will pick up and include the docstrings for the method in question.
I'm also going to submit a related PR to the
adk-docsrepo to include the module from this PR in the documentation build.Testing Plan
I run
./scripts/unittests.shas directed by the instructions inCONTRIBUTING.md.Unit Tests:
A summary of passed
pytestresults:Manual End-to-End (E2E) Tests:
Once this PR is merged, followed by the PR in
adk-docs, Python API Reference should include the docs forgoogle.adk.cli.fast_api.get_fast_api_appmethod:https://google.github.io/adk-docs/api-reference/python/google-adk.html#module-google.adk.cli
Checklist
Additional context
I will update this PR once I had submitted the one for
adk-docs.