Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Well Known API

6 actions 6 updates phrasing extends openapi/clerk-com-well-known-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 6

$.info

$.paths['/.well-known/assetlinks.json'].get

$.paths['/.well-known/jwks.json'].get

$.paths['/.well-known/apple-app-site-association'].get

$.paths['/.well-known/openid-configuration'].get

$.paths['/.well-known/oauth-authorization-server'].get

OpenAPI Overlay

# 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 Well Known API
  version: 1.0.0
extends: openapi/clerk-com-well-known-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: 5
- target: $.paths['/.well-known/assetlinks.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Android asset links for deep linking
      effect: read
      questions:
      - Where is the assetlinks.json my Android app needs for verified app links?
      - How do I check the Android asset links my auth domain serves?
      instructions:
      - text: Fetch the Android assetlinks.json for my instance.
      - text: Show the Android app link association file.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/.well-known/jwks.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the instance's JSON Web Key Set
      effect: read
      questions:
      - Where do I get the public keys to verify session JWTs?
      - What is the JWKS URL for my instance?
      instructions:
      - text: Fetch the JWKS for my instance.
      - text: Get the public signing keys from jwks.json.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/.well-known/apple-app-site-association'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Apple App Site Association file
      effect: read
      questions:
      - Where is the apple-app-site-association file for iOS universal links?
      - How do I confirm my domain serves the AASA file for my iOS app?
      instructions:
      - text: Fetch the Apple App Site Association file.
      - text: Show the iOS universal links association for my instance.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/.well-known/openid-configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the OpenID Connect discovery document
      effect: read
      questions:
      - Where is the OpenID configuration discovery document for my instance?
      - Which issuer and endpoints does the openid-configuration advertise?
      instructions:
      - text: Fetch the OpenID configuration.
      - text: Show the OIDC discovery document.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/.well-known/oauth-authorization-server'].get
  update:
    x-apievangelist-phrasing:
      intent: Get OAuth 2.0 authorization server metadata
      effect: read
      questions:
      - Does the instance publish RFC 8414 authorization server metadata?
      - Where can an OAuth client discover the token and authorize endpoints per RFC 8414?
      instructions:
      - text: Fetch the OAuth authorization server metadata.
      - text: Show the oauth-authorization-server well-known document.
      method: generated
      generated: '2026-09-26'