docs(spec): Fix whats-new-v1.md#1460
Conversation
Summary of ChangesHello @ishymko, 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 enhancing the accuracy and clarity of the Highlights
Changelog
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
|
Changes below as they appear in the file. - `blocking` flag existed in 0.3: [source](https://a2a-protocol.org/v0.3.0/specification/#712-messagesendconfiguration-object) - `SendMessage`: remove " MAY return Message"/"MUST return Task" which are not in the spec, remove service parameters mention as they are covered above - streaming was specified for gRPC in proto definition as `returns (stream StreamResponse)` - `SubscribeToTask` is not a new operation - blocking has no effect for streaming operations: [source](https://a2a-protocol.org/latest/specification/#322-sendmessageconfiguration) - `TaskNotCancelableError` was mentioned in 0.3: [source](https://a2a-protocol.org/v0.3.0/specification/#82-a2a-specific-errors) - RFC 7515 was mentioned for Agent Card signatures in 0.3: [source](https://a2a-protocol.org/v0.3.0/specification/#556-agentcardsignature-object), kept only RFC 8785 for canonicalization which wasn't - `agentId` field does not exist and never did - extension declarations (AgentExtension object) did not change between 0.3 and 1.0 - Mutual TLS existed in 0.3: [source](https://a2a-protocol.org/v0.3.0/specification/#553-securityscheme-object) - subscribing to tasks not originally created via streaming is not a behaviour change and is not explicitly mentioned in 1.0 - `token` is not removed from `PushNotificationConfig`: [source](https://a2a-protocol.org/latest/specification/#431-pushnotificationconfig) - `configId` does not exist in `PushNotificationConfig` ([source](https://a2a-protocol.org/latest/specification/#431-pushnotificationconfig)) and `id` was there in 0.3 ([source](https://a2a-protocol.org/v0.3.0/specification/#68-pushnotificationconfig-object)) - `PushNotificationNotSupportedError` existed in 0.3: [source](https://a2a-protocol.org/v0.3.0/specification/#82-a2a-specific-errors) - `SendMessageRequest` example fixed to match the spec - `createdAt` and `lastModified` do not exist in `Task`: [source](https://a2a-protocol.org/latest/specification/#411-task) - changes to nested `Task` objects removed as they are covered in respective sections (`TaskStatus`, `Message`, `Artifact`) - `timestamp` was not added to `Message`: [source](https://a2a-protocol.org/latest/specification/#414-message) - there is no "stricter typing" for `metadata` - "retained" should not be in the changelog - `createdAt` was not added to `Artifact`: [source](https://a2a-protocol.org/latest/specification/#417-artifact) - `signatures` field was there in 0.3: [source](https://a2a-protocol.org/v0.3.0/specification/#55-agentcard-object-structure)
42cbe6c to
f73853c
Compare
There was a problem hiding this comment.
Code Review
This pull request makes numerous corrections to the whats-new-v1.md documentation, improving its accuracy by aligning it with the protocol specification. The changes are well-justified and enhance the quality of the documentation. However, I've identified one area where the removal of content appears to be based on an incorrect premise regarding the AgentExtension object, and I've provided a comment to address this.
I am having trouble creating individual review comments. Click here to see my feedback.
docs/whats-new-v1.md (508-541)
The removal of this section, along with related changes in the AgentCard Object section, appears to be based on the incorrect premise that the AgentExtension object did not change between v0.3.0 and v1.0. As detailed in the content being removed, the object was significantly redesigned (e.g., id, name, and version were replaced by uri and required). This is a significant breaking change, and the detailed comparison is valuable for developers migrating to v1.0. Please consider restoring this section and the related documentation on AgentCard modifications to accurately reflect the changes in the protocol.
Currently properties for `MutualTlsSecurityScheme` are not renderred ([source](https://a2a-protocol.org/latest/specification/#456-mutualtlssecurityscheme)): <img width="1273" height="374" alt="image" src="https://github.com/user-attachments/assets/be4c7dbb-749d-4391-aec8-fdd55c0dd625" /> This PR makes casing consistent for both mkdocs anchors and heading. Tested via `mkdocs serve`: <img width="1505" height="626" alt="image" src="https://github.com/user-attachments/assets/348a6ef9-3868-43bf-8319-efe63092b95b" /> Re #1460 (comment)
darrelmiller
left a comment
There was a problem hiding this comment.
These are excellent updates. Thank you for catching all these mistakes/
|
While we're at it, should we add an entry in |
|
Apologize @holtskinner auto-merge merged the PR with your comment. I see you covered it in #1489, thank you! |
Changes below as they appear in the file.
blockingflag existed in 0.3: sourceSendMessage: remove "MAY return Message"/"MUST return Task" which are not in the spec, remove service parameters mention as they are covered abovereturns (stream StreamResponse)SubscribeToTaskis not a new operationTaskNotCancelableErrorwas mentioned in 0.3: sourceagentIdfield does not exist and never didtokenis not removed fromPushNotificationConfig: sourceconfigIddoes not exist inPushNotificationConfig(source) andidwas there in 0.3 (source)PushNotificationNotSupportedErrorexisted in 0.3: sourceSendMessageRequestexample fixed to match the speccreatedAtandlastModifieddo not exist inTask: sourceTaskobjects removed as they are covered in respective sections (TaskStatus,Message,Artifact)timestampwas not added toMessage: sourcemetadatacreatedAtwas not added toArtifact: sourcesignaturesfield was there in 0.3: sourceRe #1436.