Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Passkeys API

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

$.info

$.paths['/v1/me/passkeys'].post

$.paths['/v1/me/passkeys/{passkey_id}'].get

$.paths['/v1/me/passkeys/{passkey_id}'].delete

$.paths['/v1/me/passkeys/{passkey_id}'].patch

$.paths['/v1/me/passkeys/{passkey_id}/attempt_verification'].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 Frontend Passkeys API
  version: 1.0.0
extends: openapi/clerk-com-passkeys-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: 5
- target: $.paths['/v1/me/passkeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new passkey for my account
      effect: write
      questions:
      - How do I add a passkey to my account?
      - What starts passkey registration for the signed-in user?
      instructions:
      - text: Create a new passkey for my account.
      - text: Start registering a passkey on this device.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/passkeys/{passkey_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my passkeys
      effect: read
      questions:
      - What details are stored about one of my passkeys?
      - Can I look up a single passkey on my account by its ID?
      instructions:
      - text: Get passkey {passkey_id}.
        slots:
          passkey_id: path.passkey_id
      - text: Show the properties of my passkey {passkey_id}.
        slots:
          passkey_id: path.passkey_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/passkeys/{passkey_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a passkey
      effect: destructive
      questions:
      - How do I remove a passkey from a lost device?
      - Can I delete one of my passkeys?
      instructions:
      - text: Delete passkey {passkey_id}.
        slots:
          passkey_id: path.passkey_id
      - text: Remove my passkey {passkey_id} from my account.
        slots:
          passkey_id: path.passkey_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/passkeys/{passkey_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a passkey
      effect: write
      questions:
      - How do I give one of my passkeys a friendlier name?
      - Can I change the label of an existing passkey?
      instructions:
      - text: Rename passkey {passkey_id} to {name}.
        slots:
          passkey_id: path.passkey_id
          name: requestBody.name
      - text: Label my passkey {passkey_id} as {name}.
        slots:
          passkey_id: path.passkey_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/passkeys/{passkey_id}/attempt_verification'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a newly created passkey
      effect: write
      questions:
      - How do I finish setting up a passkey with the browser's credential response?
      - What do I submit to verify a passkey after registration?
      instructions:
      - text: Verify passkey {passkey_id} with credential {public_key_credential}.
        slots:
          passkey_id: path.passkey_id
          public_key_credential: requestBody.public_key_credential
      - text: Complete verification of new passkey {passkey_id}.
        slots:
          passkey_id: path.passkey_id
      method: generated
      generated: '2026-09-26'