Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend OAuth2 Callbacks API

3 actions 3 updates phrasing extends openapi/clerk-com-oauth2-callbacks-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Clerk's API. It is a proposal applied on top of the contract, not a document Clerk publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/oauth_callback'].get
$.paths['/v1/oauth_callback'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clerk Frontend OAuth2 Callbacks API
  version: 1.0.0
extends: openapi/clerk-com-oauth2-callbacks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v1/oauth_callback'].get
  update:
    x-apievangelist-phrasing:
      intent: Handle an OAuth provider redirect
      effect: write
      questions:
      - Which URL do OAuth providers redirect back to after a successful sign-in?
      - What does the OAuth callback do with the returned code and state?
      instructions:
      - text: Complete the OAuth redirect with code {code} and state {state}.
        slots:
          code: query.code
          state: query.state
      - text: Process an OAuth callback that returned error {error}.
        slots:
          error: query.error
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/oauth_callback'].post
  update:
    x-apievangelist-phrasing:
      intent: Handle an OAuth provider POST callback
      effect: write
      questions:
      - How are OAuth providers that POST back instead of redirecting handled?
      - Why would an OAuth callback arrive as a form POST?
      instructions:
      - text: Accept the form-posted OAuth callback with code {code} and state {state}.
        slots:
          code: requestBody.code
          state: requestBody.state
      - text: Convert the POSTed OAuth response carrying error {error} into the redirect flow.
        slots:
          error: requestBody.error
      method: generated
      generated: '2026-09-26'