API Evangelist conversational phrasing for Clerk Backend Allow-list / Block-list API

# 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 Allow-list / Block-list API
  version: 1.0.0
extends: openapi/clerk-com-allow-list-block-list-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: 6
- target: $.paths['/allowlist_identifiers'].get
  update:
    x-apievangelist-phrasing:
      intent: List allow-listed identifiers
      effect: read
      questions:
      - Which email addresses or domains are allowed to sign up to my app?
      - How do I page through the sign-up allow-list?
      instructions:
      - text: List everything on the sign-up allow-list.
      - text: Show the first {limit} allow-listed identifiers.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/allowlist_identifiers'].post
  update:
    x-apievangelist-phrasing:
      intent: Allow an identifier to sign up
      effect: write
      questions:
      - How do I let a specific email or domain sign up to a restricted app?
      - Can I notify the person when I add them to the allow-list?
      instructions:
      - text: Add {identifier} to the allow-list.
        slots:
          identifier: requestBody.identifier
      - text: 'Allow {identifier} to sign up and notify them: {notify}.'
        slots:
          identifier: requestBody.identifier
          notify: requestBody.notify
      method: generated
      generated: '2026-09-26'
- target: $.paths['/allowlist_identifiers/{identifier_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an identifier from the allow-list
      effect: destructive
      questions:
      - How do I take someone off the sign-up allow-list?
      - Can I revoke a domain's permission to sign up?
      instructions:
      - text: Delete allow-list entry {identifier_id}.
        slots:
          identifier_id: path.identifier_id
      - text: Stop allowing sign-ups for allow-listed identifier {identifier_id}.
        slots:
          identifier_id: path.identifier_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/blocklist_identifiers'].get
  update:
    x-apievangelist-phrasing:
      intent: List blocked identifiers
      effect: read
      questions:
      - Which emails or domains are blocked from accessing my app?
      - What is currently on the block-list?
      instructions:
      - text: List everything on the block-list.
      - text: Show all identifiers that are blocked from my instance.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/blocklist_identifiers'].post
  update:
    x-apievangelist-phrasing:
      intent: Block an identifier from access
      effect: write
      questions:
      - How do I block a disposable email domain from my app?
      - Can I stop a specific phone number or email from accessing my instance?
      instructions:
      - text: Add {identifier} to the block-list.
        slots:
          identifier: requestBody.identifier
      - text: Block {identifier} from accessing my application.
        slots:
          identifier: requestBody.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/blocklist_identifiers/{identifier_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an identifier from the block-list
      effect: destructive
      questions:
      - How do I unblock an email or domain I blocked earlier?
      - Can I lift a block-list entry by its ID?
      instructions:
      - text: Delete block-list entry {identifier_id}.
        slots:
          identifier_id: path.identifier_id
      - text: Unblock the blocked identifier {identifier_id}.
        slots:
          identifier_id: path.identifier_id
      method: generated
      generated: '2026-09-26'