Skip to content

docs: fix JSON schema download link - #2058

Open
coyaSONG wants to merge 2 commits into
a2aproject:mainfrom
coyaSONG:docs/fix-schema-download-link
Open

docs: fix JSON schema download link#2058
coyaSONG wants to merge 2 commits into
a2aproject:mainfrom
coyaSONG:docs/fix-schema-download-link

Conversation

@coyaSONG

@coyaSONG coyaSONG commented Jul 14, 2026

Copy link
Copy Markdown

Description

docs/definitions.md links to a version-specific spec/a2a.json artifact that
is intentionally generated during documentation builds and therefore is not
available from the GitHub source view. Keep that relative link as the primary
download so versioned documentation continues to serve its matching schema,
and add an explicitly labeled link to the official published latest artifact
for readers viewing the Markdown source on GitHub.

Validation

  • npx --yes markdownlint-cli docs/definitions.md --config .github/linters/.markdownlint.json
  • .doc-venv/bin/mkdocs build
  • Confirmed the rendered site/definitions/index.html contains both the
    version-specific relative URL and the official latest fallback URL
  • Confirmed https://a2a-protocol.org/latest/spec/a2a.json returns HTTP 200
  • git diff --check

Checklist

  • Follow the CONTRIBUTING Guide.
  • Make your Pull Request title follow the Conventional Commits specification and repository rules (e.g., docs(spec): for docs/specification.md, docs: for other docs, and feat: / fix: reserved for a2a.proto). See CONTRIBUTING.md for details.
  • Ensure the tests and linter pass (Run bash scripts/format.sh from the repository root to format)
  • Appropriate docs were updated (if necessary)

AI assistance

OpenAI Codex was used to inspect the existing schema-generation pipeline,
prepare this documentation change, address review feedback about versioned
documentation, and run the validation listed above.

Fixes #2057 🦕

@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 download link for the a2a.json schema in docs/definitions.md from a relative path to an absolute URL. The reviewer points out that using an absolute URL pointing to the latest version breaks versioning for older documentation versions, and suggests reverting to the relative path to ensure MkDocs can resolve the version-specific schema correctly.

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.

Comment thread docs/definitions.md Outdated
@coyaSONG
coyaSONG marked this pull request as ready for review July 14, 2026 10:12
@coyaSONG
coyaSONG requested review from a team as code owners July 14, 2026 10:12
Comment thread docs/definitions.md
<h3>Download</h3>

You can download the schema file directly: [`a2a.json`](spec/a2a.json)
You can download the version-specific schema file directly: [`a2a.json`](spec/a2a.json)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JLYK. Today this url refers to https://a2a-protocol.org/latest/spec/a2a.proto

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]: add missing a2a.json schema

2 participants