Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Dev Browser API

4 actions 4 updates phrasing extends openapi/clerk-com-dev-browser-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 4

$.info
$.paths['/v1/dev_browser/set_first_party_cookie'].post
$.paths['/v1/dev_browser/init'].get
$.paths['/v1/dev_browser'].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 Dev Browser API
  version: 1.0.0
extends: openapi/clerk-com-dev-browser-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v1/dev_browser/set_first_party_cookie'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the dev browser first-party cookie
      effect: write
      questions:
      - How does a development instance set its first-party dev browser cookie?
      - What sets the dev browser cookie on my own domain?
      instructions:
      - text: Set the dev browser first-party cookie.
      - text: Write the development first-party cookie for this browser.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dev_browser/init'].get
  update:
    x-apievangelist-phrasing:
      intent: Initialize a dev browser for a development instance
      effect: read
      questions:
      - How do I initialize a dev browser for a staging or development instance?
      - Which origin does dev browser initialization apply to?
      instructions:
      - text: Initialize a dev browser for origin {origin}.
        slots:
          origin: query.origin
      - text: Start a development browser session.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dev_browser'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Dev Browser token
      effect: write
      questions:
      - How do I authenticate requests against a development instance?
      - What token must be set before calling a dev instance's frontend API?
      instructions:
      - text: Create a Dev Browser token.
      - text: Generate a DevBrowser token for my development instance.
      method: generated
      generated: '2026-10-01'