-
Notifications
You must be signed in to change notification settings - Fork 120
feat!: Align spec classes with the a2a.proto, removing compatibility code #546
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
…ompatibility code Note this does not remove the 'kind' field, which will be done in a2aproject#544
This reverts commit 71ff747.
Removed excessive newlines from Javadoc comments in several classes in the io.a2a.spec package, and corrected a misplaced @param tag in SubscribeToTaskRequest.
Summary of ChangesHello @kabir, 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 focuses on modernizing the A2A Java specification by aligning its classes with the 1.0.0 version of the A2A protocol. It systematically removes outdated compatibility code, particularly deprecated fields and methods, which simplifies the API and reduces technical debt. Additionally, a significant effort has been made to enhance the Javadoc documentation throughout the codebase, ensuring that the purpose and usage of various classes, constructors, and methods are clearly explained for developers. Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
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 primarily focuses on enhancing Javadoc documentation across numerous classes within the spec and spec-grpc modules. Key changes include adding detailed Javadoc comments for constructors, fields, and builder methods in various request, response, error, and data model classes (e.g., AgentCard, JsonUtil, JSONRPCRequest, JSONRPCResponse, Task, Message, TaskStatusUpdateEvent, and many others). Several deprecated method builder methods were removed from JSON-RPC request builders, and deprecated fields in AgentCardMapper were reordered and updated with new comments. Additionally, AgentCard's Javadoc was updated to clarify supportedInterfaces, and the deprecated additionalInterfaces() method was removed. Review comments highlighted and requested the removal of excessive blank lines within Javadoc blocks for improved readability, which was addressed in multiple files.
| /** | ||
|
|
||
|
|
||
| * Builder for constructing GetTaskPushNotificationConfigParams instances. | ||
|
|
||
|
|
||
| */ | ||
|
|
||
|
|
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.
spec/src/main/java/io/a2a/spec/GetTaskPushNotificationConfigResponse.java
Outdated
Show resolved
Hide resolved
spec/src/main/java/io/a2a/spec/GetTaskPushNotificationConfigResponse.java
Outdated
Show resolved
Hide resolved
spec/src/main/java/io/a2a/spec/GetTaskPushNotificationConfigResponse.java
Outdated
Show resolved
Hide resolved
spec/src/main/java/io/a2a/spec/SendStreamingMessageResponse.java
Outdated
Show resolved
Hide resolved
spec/src/main/java/io/a2a/spec/SetTaskPushNotificationConfigRequest.java
Show resolved
Hide resolved
spec/src/main/java/io/a2a/spec/SetTaskPushNotificationConfigRequest.java
Show resolved
Hide resolved
spec/src/main/java/io/a2a/spec/SetTaskPushNotificationConfigRequest.java
Show resolved
Hide resolved
spec/src/main/java/io/a2a/spec/SetTaskPushNotificationConfigRequest.java
Outdated
Show resolved
Hide resolved
|
/gemini review |
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 does a great job of aligning the spec classes with the a2a.proto definitions by removing deprecated compatibility code and significantly improving the Javadoc across many files. The changes make the codebase cleaner and easier to understand.
I've added a few minor comments regarding unnecessary blank lines that affect code formatting. These are stylistic suggestions to improve consistency and readability. Overall, this is a solid improvement.
spec/src/main/java/io/a2a/spec/SendStreamingMessageRequest.java
Outdated
Show resolved
Hide resolved
spec/src/main/java/io/a2a/spec/SendStreamingMessageResponse.java
Outdated
Show resolved
Hide resolved
spec/src/main/java/io/a2a/spec/SetTaskPushNotificationConfigRequest.java
Outdated
Show resolved
Hide resolved
|
/gemini review |
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 does a great job of aligning the spec classes with the a2a.proto specification by removing deprecated compatibility code and significantly improving documentation across the board. The addition of Javadocs to numerous classes, methods, and fields greatly enhances code clarity and maintainability.
I've found one potential inconsistency in the JSON-RPC method name for listing tasks, which I've detailed in a specific comment. Otherwise, the changes are solid and move the codebase in the right direction.
|
/gemini review |
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 is a great step forward in aligning the spec classes with the a2a.proto definitions and removing outdated compatibility code. The removal of deprecated methods and fields cleans up the API significantly. The extensive addition of Javadoc across numerous files is a major improvement for code clarity and maintainability. I've found only one minor issue regarding Javadoc formatting that should be addressed.
spec/src/main/java/io/a2a/spec/OpenIdConnectSecurityScheme.java
Outdated
Show resolved
Hide resolved
|
/gemini review |
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 primarily focuses on enhancing code documentation across numerous Java classes, particularly within the spec and spec-grpc modules. Key changes include adding comprehensive Javadoc comments to constructors, fields, and methods in various record classes and JSON-RPC request/response objects, such as AgentCard, JsonUtil, JSONRPCRequest, and JSONRPCResponse and their subclasses. Specific updates involve clarifying deprecated fields in AgentCardMapper.java, adding notes about MapStruct property derivation, and providing detailed explanations for parameters in compact constructors and builder methods. Additionally, several deprecated method builder methods were removed from JSON-RPC request classes, and the additionalInterfaces() method was removed from AgentCard.java.
…code (a2aproject#546) We do not need to stay compliant with 0.x.0 versions of the spec, and it should be more stable after 1.0. Note this does not remove the 'kind' field, which will be done in a2aproject#544
We do not need to stay compliant with 0.x.0 versions of the spec, and it should be more stable after 1.0.
Note this does not remove the 'kind' field, which will be done in #544