Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend TOTP API

4 actions 4 updates phrasing extends openapi/clerk-com-totp-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/me/totp'].post
$.paths['/v1/me/totp'].delete
$.paths['/v1/me/totp/attempt_verification'].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 TOTP API
  version: 1.0.0
extends: openapi/clerk-com-totp-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: 3
- target: $.paths['/v1/me/totp'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up an authenticator app secret
      effect: write
      questions:
      - How do I enable an authenticator app for two-step verification on my account?
      - Can I create a second TOTP secret if I already have one?
      instructions:
      - text: Generate a new TOTP secret for my authenticator app.
      - text: Start authenticator app setup on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/totp'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove my authenticator app
      effect: destructive
      questions:
      - How do I turn off authenticator-app two-factor on my account?
      - What happens to my existing authenticators when I delete my TOTP secret?
      instructions:
      - text: Delete my TOTP secret.
      - text: Disable my authenticator app two-factor.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/totp/attempt_verification'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm authenticator app setup with a code
      effect: write
      questions:
      - How do I finish setting up my authenticator app with the six-digit code?
      - What do I send to verify a newly created TOTP secret?
      instructions:
      - text: Verify my authenticator app with code {code}.
        slots:
          code: requestBody.code
      - text: Confirm my TOTP setup using code {code}.
        slots:
          code: requestBody.code
      method: generated
      generated: '2026-09-26'