Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Redirect API

2 actions 2 updates phrasing extends openapi/clerk-com-redirect-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 2

$.info
$.paths['/v1/redirect'].get

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 Redirect API
  version: 1.0.0
extends: openapi/clerk-com-redirect-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: 1
- target: $.paths['/v1/redirect'].get
  update:
    x-apievangelist-phrasing:
      intent: Redirect to a validated URL
      effect: read
      questions:
      - How do I safely redirect a user after an auth flow?
      - What happens if no redirect URL is given?
      instructions:
      - text: Redirect to {redirect_url} after validating it.
        slots:
          redirect_url: query.redirect_url
      - text: Send the user to the default redirect URL.
      method: generated
      generated: '2026-09-26'