Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Backend Proxy Checks API

2 actions 2 updates phrasing extends openapi/clerk-com-proxy-checks-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['/proxy_checks'].post

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 Backend Proxy Checks API
  version: 1.0.0
extends: openapi/clerk-com-proxy-checks-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['/proxy_checks'].post
  update:
    x-apievangelist-phrasing:
      intent: Check that a domain's proxy is working
      effect: read
      questions:
      - How do I confirm my proxy URL can reach the Frontend API before enabling it?
      - Is my proxy-enabled domain configured correctly?
      instructions:
      - text: Verify proxy URL {proxy_url} for domain {domain_id}.
        slots:
          proxy_url: requestBody.proxy_url
          domain_id: requestBody.domain_id
      - text: Check the proxy setup of domain {domain_id}.
        slots:
          domain_id: requestBody.domain_id
      method: generated
      generated: '2026-09-26'