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 26 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. |
|
Hello, @xuanyang15. I'm curious if there is any progress on that internal review, please. |
|
@olliefr Sorry for the delay! The imported change has been waiting for review for a while. The internal reviewers finally decided to the reject this change because get_fast_api_app is not the standard interface we want to maintain. |
|
@xuanyang15 I can see why they don't want to maintain this interface. It's an internal implementation detail of the It wouldn't be an issue if that were its only use. Unfortunately, this undocumented internal module features extensively where it should not: in the end-user documentation. If they do not want to commit to documenting and maintaining this interface, the only intellectually honest response is to update the documentation to show end users how to create a FastAPI object explicitly, without relying on As of today, the Cloud Run deployment documentation still uses Who, in their right mind is going to build production container images from unstable, undocumented components? Not many. So the Cloud Run and GKE deployment examples in the end-user documentation are, evidently, not fit for production use. And for no good reason! I encourage the internal reviewers to think about that. Thank you.
|

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.