API Evangelist conversational phrasing for Clerk Com Domains 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 Com Domains API
  version: 1.0.0
extends: openapi/clerk-com-domains-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: 20
- target: $.paths['/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List my instance's primary and satellite domains
      effect: read
      questions:
      - Which domains is my Clerk instance currently running on, including satellites?
      - Can I see the primary domain alongside every satellite domain for this instance?
      instructions:
      - text: List the primary and satellite domains configured on my instance.
      - text: Show me the frontend and accounts URLs for each domain on this instance.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a satellite domain to an instance
      effect: write
      questions:
      - How do I add a satellite domain to a multi-domain instance?
      - Can a new instance domain include a port like localhost:3000 in development?
      instructions:
      - text: Add {name} as a satellite domain on my instance.
        slots:
          name: requestBody.name
      - text: Add satellite domain {name} served through proxy {proxy_url}.
        slots:
          name: requestBody.name
          proxy_url: requestBody.proxy_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/domains/{domain_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a satellite domain from the instance
      effect: destructive
      questions:
      - How do I remove a satellite domain I no longer use from my instance?
      - Is it possible to delete the instance's primary domain?
      instructions:
      - text: Delete satellite domain {domain_id} from my instance.
        slots:
          domain_id: path.domain_id
      - text: Remove the satellite instance domain {domain_id}.
        slots:
          domain_id: path.domain_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/domains/{domain_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an instance domain or its proxy URL
      effect: write
      questions:
      - How do I set a proxy URL on my production instance's domain?
      - Can I rename a primary or satellite domain on my instance after it's created?
      instructions:
      - text: Set the proxy URL of instance domain {domain_id} to {proxy_url}.
        slots:
          domain_id: path.domain_id
          proxy_url: requestBody.proxy_url
      - text: Rename instance domain {domain_id} to {name}.
        slots:
          domain_id: path.domain_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's domains
      effect: read
      questions:
      - Which email domains are attached to this organization?
      - Can I filter an organization's domains to only verified ones or by enrollment mode?
      instructions:
      - text: List the domains of organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show only verified domains for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a domain to an organization
      effect: write
      questions:
      - How do I add a company email domain to an organization as the signed-in user?
      - What do I need to register a new domain on my organization?
      instructions:
      - text: Add domain {name} to organization {organization_id}.
        slots:
          name: requestBody.name
          organization_id: path.organization_id
      - text: Register {name} as an organization domain for {organization_id}.
        slots:
          name: requestBody.name
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}/domains/{domain_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one organization domain's details
      effect: read
      questions:
      - What are the verification and enrollment details of one organization domain?
      - Can I look up a single domain on my organization by its ID?
      instructions:
      - text: Get domain {domain_id} of organization {organization_id}.
        slots:
          domain_id: path.domain_id
          organization_id: path.organization_id
      - text: Show the verification status of organization domain {domain_id} in {organization_id}.
        slots:
          domain_id: path.domain_id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}/domains/{domain_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a domain from an organization
      effect: destructive
      questions:
      - How do I remove an email domain from my organization?
      - Who is allowed to delete a domain from an organization?
      instructions:
      - text: Remove domain {domain_id} from organization {organization_id}.
        slots:
          domain_id: path.domain_id
          organization_id: path.organization_id
      - text: Delete organization domain {domain_id} under {organization_id}.
        slots:
          domain_id: path.domain_id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}/domains/{domain_id}/update_enrollment_mode'].post
  update:
    x-apievangelist-phrasing:
      intent: Change an organization domain's enrollment mode
      effect: write
      questions:
      - How do I make users with a matching email domain get automatic invitations to the organization?
      - Can I switch a domain from automatic invitation to automatic suggestion and drop pending ones?
      instructions:
      - text: Set enrollment mode of domain {domain_id} in organization {organization_id} to {enrollment_mode}.
        slots:
          domain_id: path.domain_id
          organization_id: path.organization_id
          enrollment_mode: requestBody.enrollment_mode
      - text: Switch domain {domain_id} of {organization_id} to automatic_suggestion enrollment.
        slots:
          domain_id: path.domain_id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}/domains/{domain_id}/prepare_affiliation_verification'].post
  update:
    x-apievangelist-phrasing:
      intent: Start affiliation verification for an org domain
      effect: write
      questions:
      - How do I prove I own an email address at my organization's domain?
      - What starts the affiliation email check for an organization domain?
      instructions:
      - text: Send an affiliation verification to {affiliation_email_address} for domain {domain_id} of {organization_id}.
        slots:
          affiliation_email_address: requestBody.affiliation_email_address
          domain_id: path.domain_id
          organization_id: path.organization_id
      - text: Prepare affiliation verification for organization domain {domain_id} in {organization_id} using {affiliation_email_address}.
        slots:
          affiliation_email_address: requestBody.affiliation_email_address
          domain_id: path.domain_id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}/domains/{domain_id}/attempt_affiliation_verification'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify an org domain with an affiliation code
      effect: write
      questions:
      - I received an affiliation code by email, how do I use it to verify my organization domain?
      - What happens when I submit the affiliation verification code for an organization domain?
      instructions:
      - text: Verify organization domain {domain_id} in {organization_id} with code {code}.
        slots:
          domain_id: path.domain_id
          organization_id: path.organization_id
          code: requestBody.code
      - text: Submit affiliation code {code} for domain {domain_id} of organization {organization_id}.
        slots:
          domain_id: path.domain_id
          organization_id: path.organization_id
          code: requestBody.code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/domain'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an application's production domain
      effect: write
      questions:
      - How do I change the production domain of one of my Clerk applications?
      - Can I set a proxy path when I move an application to a new production domain?
      instructions:
      - text: Change the production domain of application {applicationID} to {name}.
        slots:
          applicationID: path.applicationID
          name: requestBody.name
      - text: Move application {applicationID} to production domain {name} behind proxy path {proxy_path}.
        slots:
          applicationID: path.applicationID
          name: requestBody.name
          proxy_path: requestBody.proxy_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's production domains
      effect: read
      questions:
      - Which domains are on this application's production instance?
      - Can I see every provider domain attached to one application?
      instructions:
      - text: List production domains for application {applicationID}.
        slots:
          applicationID: path.applicationID
      - text: Show all domains on the production instance of {applicationID}.
        slots:
          applicationID: path.applicationID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a provider domain to an application
      effect: write
      questions:
      - How do I add another provider domain to an application's production instance?
      - Can an extra production domain for an application use a proxy path?
      instructions:
      - text: Add provider domain {name} to application {applicationID}.
        slots:
          name: requestBody.name
          applicationID: path.applicationID
      - text: Create domain {name} on the production instance of {applicationID} with proxy path {proxy_path}.
        slots:
          name: requestBody.name
          applicationID: path.applicationID
          proxy_path: requestBody.proxy_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/domains/{domainIDOrName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one domain of an application
      effect: read
      questions:
      - Can I look up an application domain by its name instead of its ID?
      - What configuration does a specific domain of my application have?
      instructions:
      - text: Get domain {domainIDOrName} of application {applicationID}.
        slots:
          domainIDOrName: path.domainIDOrName
          applicationID: path.applicationID
      - text: Show details for application {applicationID}'s domain {domainIDOrName}.
        slots:
          domainIDOrName: path.domainIDOrName
          applicationID: path.applicationID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/domains/{domainIDOrName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a provider domain from an application
      effect: destructive
      questions:
      - How do I remove a provider domain from an application's production instance?
      - Can the primary domain of an application be deleted?
      instructions:
      - text: Delete provider domain {domainIDOrName} from application {applicationID}.
        slots:
          domainIDOrName: path.domainIDOrName
          applicationID: path.applicationID
      - text: Remove {domainIDOrName} from the production domains of {applicationID}.
        slots:
          domainIDOrName: path.domainIDOrName
          applicationID: path.applicationID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/domains/{domainIDOrName}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an application domain's status
      effect: read
      questions:
      - Is my application's domain fully set up yet?
      - What is the current DNS and SSL status of an application domain?
      instructions:
      - text: Check the status of domain {domainIDOrName} for application {applicationID}.
        slots:
          domainIDOrName: path.domainIDOrName
          applicationID: path.applicationID
      - text: Tell me whether {domainIDOrName} on application {applicationID} is ready.
        slots:
          domainIDOrName: path.domainIDOrName
          applicationID: path.applicationID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/domains/{domainIDOrName}/dns_check'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a fresh DNS check on an application domain
      effect: write
      questions:
      - How do I force a new DNS check after updating my domain's records?
      - Why would triggering a DNS check return a 409 conflict?
      instructions:
      - text: Trigger a DNS check for domain {domainIDOrName} of application {applicationID}.
        slots:
          domainIDOrName: path.domainIDOrName
          applicationID: path.applicationID
      - text: Re-run DNS verification on {domainIDOrName} for {applicationID} now.
        slots:
          domainIDOrName: path.domainIDOrName
          applicationID: path.applicationID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List domains across my workspace's applications
      effect: read
      questions:
      - Which production domains exist across all applications in my workspace?
      - Can I include development instance domains when listing my workspace's domains?
      instructions:
      - text: List every production domain in my workspace, newest first.
      - text: Find workspace domains matching {name}, including development ones.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/domains/{domainIDOrName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace domain by ID or name
      effect: read
      questions:
      - Can I look up a domain in my workspace without knowing which application owns it?
      - What does the workspace-level record for a single domain contain?
      instructions:
      - text: Get workspace domain {domainIDOrName}.
        slots:
          domainIDOrName: path.domainIDOrName
      - text: Look up {domainIDOrName} across my workspace's domains.
        slots:
          domainIDOrName: path.domainIDOrName
      method: generated
      generated: '2026-09-26'