Skip to content

docs(api): v2.x API envelope contract + JWKS verification - #76

Open
zootechdrum wants to merge 1 commit into
mainfrom
docs/api-envelope-contract
Open

zootechdrum wants to merge 1 commit into
mainfrom
docs/api-envelope-contract

Conversation

@zootechdrum

Copy link
Copy Markdown
Contributor

Summary

  • Response envelope — documents the {data, meta} wrapper, both pagination formats (snapshot + cursor), and meta.warning degraded-state signals
  • Error shapes — documents both coexisting error shapes (legacy {status_code, message} and envelope {error: {code, message}}), full HTTP→semantic code mapping, rate limit headers, and issuer route auth distinction
  • JWKS / Access Token verification — documents the two-step POST /verify/sessionPOST /verify/complete flow with offline attestation JWT verification via GET /.well-known/jwks.json
  • Broken anchor fixerror-handling.mdx next steps link updated to point to the correct transaction state machine page

Files changed

  • content/docs/api/core/api-concepts.mdx — response envelope, pagination, warnings
  • content/docs/api/accounts/api-integration.mdx — both error shapes, rate limit headers, issuer route auth
  • content/docs/api/accounts/authentication.mdx — JWKS + access token verification flow
  • content/docs/api/core/error-handling.mdx — broken anchor fix

Test plan

  • npm run dev — verify all four pages render without errors
  • Check api-concepts.mdx — response envelope section appears above The Source Field
  • Check api-integration.mdx — both error shapes present, rate limit headers section present
  • Check authentication.mdx — Access Token Verification section renders at bottom of page
  • Verify JWKS code example compiles (no undefined variables)

🤖 Generated with Claude Code

@vercel

vercel Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
andamio-documentation Ready Ready Preview Aug 11, 2026 4:23pm

Request Review

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.

1 participant