-
Notifications
You must be signed in to change notification settings - Fork 297
fix: openapi working in sub-app #324
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @racinmat, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses a bug where the OpenAPI schema for A2A-specific components was not being correctly generated, particularly when the FastAPI application was operating as a sub-application. The core solution involves refactoring the custom OpenAPI component injection mechanism from a lifespan event to an overridden openapi() method within a dedicated FastAPI subclass, ensuring consistent and correct schema generation.
Highlights
- Custom FastAPI Subclass: I've introduced
A2AFastAPI, a custom subclass ofFastAPI, specifically designed to encapsulate and manage the addition of A2A-specific OpenAPI schema components. - Refactored OpenAPI Schema Generation: The logic for injecting
A2ARequestand related schemas into the OpenAPI definition has been moved. Previously handled within alifespanevent handler, this is now managed by overriding theopenapi()method within the newA2AFastAPIclass. This change ensures the schema is correctly built, especially when the application is mounted as a sub-application, resolving the reported issue. - Python Version Compatibility: To ensure broader compatibility, I've added conditional imports for the
overridedecorator, usingtyping_extensions.overridefor Python versions prior to 3.12 andtyping.overridefor Python 3.12 and later.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request refactors the OpenAPI generation for A2A sub-applications by introducing the A2AFastAPI class. The changes improve the handling of OpenAPI schema generation in sub-applications.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
@racinmat Thanks for the contribution, can you add tests for your change to show that it works with sub-applications? |
|
@holtskinner added |
|
@kthota-g @pstephengoogle Can you please review? |
|
@kthota-g @pstephengoogle please, this would really simplify my life, and I think it would help others too. |
|
@holtskinner is there anyone else who could review it instead? |
🤖 I have created a release *beep* *boop* --- ## [0.3.1](v0.3.0...v0.3.1) (2025-08-13) ### Features * Add agent card as a route in rest adapter ([ba93053](ba93053)) ### Bug Fixes * gracefully handle task exceptions in event consumer ([#383](#383)) ([2508a9b](2508a9b)) * openapi working in sub-app ([#324](#324)) ([dec4b48](dec4b48)) * Pass `message_length` param in `get_task()` ([#384](#384)) ([b6796b9](b6796b9)) * relax protobuf dependency version requirement ([#381](#381)) ([0f55f55](0f55f55)) * Use HasField for simple message retrieval for grpc transport ([#380](#380)) ([3032aa6](3032aa6)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
The
A2AFastAPIApplicationis very useful, but currently can not be used as a Sub Application without breaking the openapi specification.Lifespan does not work for Sub Applications, which makes this otherwise useful integration work in existing larger FastAPI apps.
This fix gets rid of the lifespan and instead enriches the openapi on the first call of the openapi method.
I tested it locally and everything works with sub-application.
The following works after the fix with openapi components populated:
I am not adding
@overridealthough this overrides theopenapi, because the pyright fails on it, see the failed lint run.