fix(proto): correct gRPC URL example in AgentInterface#1997
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for the AgentInterface message in specification/a2a.proto to clarify the expected format of the url field for both HTTP-based and gRPC transports. The review feedback suggests refining the terminology from "URL" to "URL or address" when referring to gRPC endpoints to ensure technical accuracy, as gRPC addresses in the format "hostname:port" lack a scheme.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| // The URL where this interface is available. For HTTP-based transports, must be a valid absolute | ||
| // HTTPS URL in production. For gRPC, the URL should be in the format "hostname:port". | ||
| // Example: "https://api.example.com/a2a/v1", "grpc.example.com:443" |
There was a problem hiding this comment.
Since hostname:port is an address/endpoint rather than a URL (as it lacks a scheme), referring to it as 'the URL' for gRPC is technically inaccurate. It would be clearer to refer to it as 'the address' or 'the URL or address' to accommodate both HTTP and gRPC transports.
| // The URL where this interface is available. For HTTP-based transports, must be a valid absolute | |
| // HTTPS URL in production. For gRPC, the URL should be in the format "hostname:port". | |
| // Example: "https://api.example.com/a2a/v1", "grpc.example.com:443" | |
| // The URL or address where this interface is available. For HTTP-based transports, must be a valid absolute | |
| // HTTPS URL in production. For gRPC, the address should be in the format "hostname:port". | |
| // Example: "https://api.example.com/a2a/v1", "grpc.example.com:443" |
The previous example used "https://grpc.example.com/a2a" which is incorrect for gRPC — gRPC URLs use "hostname:port" format without a scheme or path. Also updated the field comment to clarify that the HTTPS URL requirement applies to HTTP-based transports only. Fixes #1388 Signed-off-by: Sam Betts <1769706+Tehsmash@users.noreply.github.com>
bcd1c02 to
8653eda
Compare
|
Verified this fix independently while tracing the same example. The reference SDK confirms the corrected format: a2a-go's gRPC transport passes |
Summary
Fixes the incorrect gRPC URL example in the
AgentInterfacemessage ofa2a.proto.Problem: The example showed
"https://grpc.example.com/a2a"for a gRPC interface, but gRPC URLs do not use anhttps://scheme or a path. The correct format ishostname:port.Fix:
"https://grpc.example.com/a2a"to"grpc.example.com:443"hostname:portformatFixes #1388