Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Waitlist API

2 actions 2 updates phrasing extends openapi/clerk-com-waitlist-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/waitlist'].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 Waitlist API
  version: 1.0.0
extends: openapi/clerk-com-waitlist-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/waitlist'].post
  update:
    x-apievangelist-phrasing:
      intent: Join the waitlist
      effect: write
      questions:
      - How do I add someone's email to the waitlist?
      - What happens if an email is already on the waitlist?
      instructions:
      - text: Add {email_address} to the waitlist.
        slots:
          email_address: requestBody.email_address
      - text: Sign {email_address} up for the waitlist.
        slots:
          email_address: requestBody.email_address
      method: generated
      generated: '2026-09-26'