Skip to content

docs(spec): document SecurityRequirement and StringList types#2021

Open
msrivastav13 wants to merge 2 commits into
a2aproject:mainfrom
msrivastav13:fix/spec-securityrequirement-section
Open

docs(spec): document SecurityRequirement and StringList types#2021
msrivastav13 wants to merge 2 commits into
a2aproject:mainfrom
msrivastav13:fix/spec-securityrequirement-section

Conversation

@msrivastav13

Copy link
Copy Markdown
Contributor

Description

The AgentCard and AgentSkill field tables both reference SecurityRequirement and link to #securityrequirement, but no such section exists in the specification — sections 4.5.1 through 4.5.10 cover the security schemes, but SecurityRequirement itself is undocumented. This makes the link dead (see the screenshot in #1658).

SecurityRequirement is defined in specification/a2a.proto (message SecurityRequirement { map<string, StringList> schemes = 1; }) and its table in turn references StringList, which was also undocumented.

Change

Add two sections in the Security Objects group, both rendered by the existing proto_to_table macro with matching <a id="..."> anchors:

  • 4.5.11. SecurityRequirement
  • 4.5.12. StringList

This makes the existing #securityrequirement links from AgentCard/AgentSkill resolve, and also covers the #stringlist link that the new SecurityRequirement table generates, so no new broken link is introduced.

Verified by invoking the proto_to_table macro directly against a2a.proto: both messages are found and render valid tables.

Related issue

Fixes #1658

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
@msrivastav13
msrivastav13 requested a review from a team as a code owner July 1, 2026 04:35

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

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 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: Missing SecurityRequirement section referenced in AgentSkill

2 participants