Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Proxy Health API

2 actions 2 updates phrasing extends openapi/clerk-com-proxy-health-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/proxy-health'].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 Proxy Health API
  version: 1.0.0
extends: openapi/clerk-com-proxy-health-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/proxy-health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a domain's proxy configuration
      effect: read
      questions:
      - How do I test whether my Frontend API proxy is set up correctly for a domain?
      - Which headers does the proxy health check need?
      instructions:
      - text: Check the proxy setup for domain {domain_id} at proxy URL {proxy_url}.
        slots:
          domain_id: query.domain_id
          proxy_url: header.Clerk-Proxy-Url
      - text: Validate the proxy configuration of domain {domain_id}.
        slots:
          domain_id: query.domain_id
      method: generated
      generated: '2026-09-26'