docs(spec): document SecurityRequirement and StringList types#2021
Open
msrivastav13 wants to merge 2 commits into
Open
docs(spec): document SecurityRequirement and StringList types#2021msrivastav13 wants to merge 2 commits into
msrivastav13 wants to merge 2 commits into
Conversation
The AgentCard and AgentSkill field tables both link to a SecurityRequirement section (#securityrequirement) that did not exist, producing a dead intra-document link. SecurityRequirement in turn references StringList, which was also undocumented. Add sections 4.5.11 (SecurityRequirement) and 4.5.12 (StringList), rendered via the existing proto_to_table macro with matching anchors, so both cross-references resolve. Fixes a2aproject#1658
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in docs/specification.md by adding sections for SecurityRequirement (4.5.11) and StringList (4.5.12), including their corresponding protobuf tables. There are no review comments, and I have no additional feedback to provide.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The
AgentCardandAgentSkillfield tables both referenceSecurityRequirementand link to#securityrequirement, but no such section exists in the specification — sections 4.5.1 through 4.5.10 cover the security schemes, butSecurityRequirementitself is undocumented. This makes the link dead (see the screenshot in #1658).SecurityRequirementis defined inspecification/a2a.proto(message SecurityRequirement { map<string, StringList> schemes = 1; }) and its table in turn referencesStringList, which was also undocumented.Change
Add two sections in the Security Objects group, both rendered by the existing
proto_to_tablemacro with matching<a id="...">anchors:This makes the existing
#securityrequirementlinks from AgentCard/AgentSkill resolve, and also covers the#stringlistlink that the new SecurityRequirement table generates, so no new broken link is introduced.Verified by invoking the
proto_to_tablemacro directly againsta2a.proto: both messages are found and render valid tables.Related issue
Fixes #1658