Skip to content

docs(integrator): document RFC 8707 / RFC 8414 / MCP audience binding#190

Merged
appleboy merged 1 commit into
mainfrom
worktree-docs
May 17, 2026
Merged

docs(integrator): document RFC 8707 / RFC 8414 / MCP audience binding#190
appleboy merged 1 commit into
mainfrom
worktree-docs

Conversation

@appleboy
Copy link
Copy Markdown
Member

Summary

  • Re-aligns the in-app integrator docs (internal/templates/docs/) with PR feat(oauth): add MCP / RFC 8707 + RFC 8414 compatibility #187. The previous guidance told resource-server implementers to disable aud validation; that's now wrong because access tokens may carry a per-request aud from RFC 8707 resource parameters. Each Go/Python/Node example is updated to enforce aud, and the Verification Steps now require both type=access and an aud match against the resource server's identifier.
  • Documents the optional resource parameter on all three flow guides (auth-code, device, client-credentials) and on token refresh, including the RFC 8707 §2.2 subset rule and the new invalid_target error.
  • Surfaces /.well-known/oauth-authorization-server (RFC 8414) and adds a Resource Indicator Errors section to the error reference.
  • All eight pages plus their zh-TW/ translations are kept in lockstep. zh-TW headings that anchor in-page links (Audience Binding, Resource Indicator 錯誤) use ASCII parens so the markdownlint MD051 GitHub-style slugger matches the link fragments.
  • .markdownlint.json: disables MD028 (no-blanks-blockquote) so adjacent callout blocks can stay separated by a blank line without lint noise.

Test plan

  • make generate && make build succeeds (templates unchanged, but verify the docs handler still embeds the new files).
  • Run ./bin/authgate server and visit /docs/en/jwt-verification. Confirm the new Audience Binding (RFC 8707) section renders and the in-page #audience-binding-rfc-8707 jump links work from the claims table and Verification Steps.
  • Visit /docs/zh-TW/jwt-verification and /docs/zh-TW/errors. Confirm the same in-page anchors (#audience-binding-rfc-8707, #resource-indicator-錯誤-rfc-8707) jump correctly.
  • Run markdownlint internal/templates/docs/**/*.md (or whatever the repo uses) — zero MD051 violations expected.
  • Spot-check every flow guide for the resource parameter row in the request-parameters table.

🤖 Generated with Claude Code

- Replace stale "access tokens have no aud" guidance with RFC 8707 audience-binding validation, including new Audience Binding sections and aud-aware Go/Python/Node examples
- Document the optional resource parameter and §2.2 narrowing rule on the auth-code, device, client-credentials, and refresh flows
- Add invalid_target error and a Resource Indicator Errors section to the errors reference
- Surface the /.well-known/oauth-authorization-server (RFC 8414) metadata endpoint and resource-identifier onboarding hint
- Mirror all updates in the Traditional Chinese translations and disable markdownlint MD028 for unavoidable adjacent callouts
Copilot AI review requested due to automatic review settings May 17, 2026 05:15
@codecov
Copy link
Copy Markdown

codecov Bot commented May 17, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@appleboy appleboy merged commit 46d7ca3 into main May 17, 2026
20 of 21 checks passed
@appleboy appleboy deleted the worktree-docs branch May 17, 2026 05:21
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.

2 participants