Skip to content

docs: add OAuth response examples#171

Merged
basit3407 merged 1 commit into
mainfrom
codex/oauth-response-examples
Jun 4, 2026
Merged

docs: add OAuth response examples#171
basit3407 merged 1 commit into
mainfrom
codex/oauth-response-examples

Conversation

@basit3407

@basit3407 basit3407 commented Jun 4, 2026

Copy link
Copy Markdown
Collaborator

Split out from PR #167 so OAuth/OIDC response examples can be reviewed independently.

Scope:

  • Adds token exchange examples for authorization-code and refresh-token flows.
  • Adds token/introspection/userinfo error examples.
  • Adds active and inactive introspection examples.
  • Adds authorize endpoint invalid request/redirect URI examples.

Local validation:

  • Parsed openAPI/oauth2-apis/v1.json with Node.
  • Checked every OAuth JSON response has a top-level example.
  • git diff --check

Hosted validation:

  • Cloudflare Pages passed.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying qf-api-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 85cbc59
Status: ✅  Deploy successful!
Preview URL: https://1fb49397.qf-api-docs.pages.dev
Branch Preview URL: https://codex-oauth-response-example.qf-api-docs.pages.dev

View logs

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

Pull request overview

This PR updates the OAuth2 OpenAPI specification to include concrete JSON response examples for key OAuth/OIDC endpoints, making the docs more useful for client implementers and easier to validate in tooling.

Changes:

  • Added success examples for /oauth2/token covering authorization-code and refresh-token exchanges.
  • Added error examples for /oauth2/token, /oauth2/introspect, /oauth2/auth, and /userinfo.
  • Added active/inactive token examples for /oauth2/introspect.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@basit3407 basit3407 merged commit f0ebfd4 into main Jun 4, 2026
2 checks passed
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