# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Management Custom Domains API
  version: 1.0.0
extends: openapi/auth0-custom-domains-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: 9
- target: $.paths['/custom-domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom domains
      effect: read
      questions:
      - Which custom domains are configured for my tenant?
      - Can I search my custom domains by name or sort them?
      instructions:
      - text: List all my custom domains.
      - text: Search my custom domains matching {q}.
        slots:
          q: query.q
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new custom domain
      effect: write
      questions:
      - How do I serve my login page from my own domain like login.example.com?
      - Can I choose between an Auth0-managed and a self-managed certificate for a new domain?
      instructions:
      - text: Add custom domain {domain} with certificate type {type}.
        slots:
          domain: requestBody.domain
          type: requestBody.type
      - text: Register {domain} as a {type} custom domain using TLS policy {tls_policy}.
        slots:
          domain: requestBody.domain
          type: requestBody.type
          tls_policy: requestBody.tls_policy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-domains/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tenant's default domain
      effect: read
      questions:
      - Which domain is the default for my tenant right now?
      - Is one of my custom domains set as the default?
      instructions:
      - text: Show me my tenant's default domain.
      - text: Tell me which custom domain is currently the default.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-domains/default'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set the default custom domain
      effect: write
      questions:
      - How do I make one of my custom domains the default for emails and links?
      - Can I change the tenant's default domain?
      instructions:
      - text: Make {domain} the default custom domain.
        slots:
          domain: requestBody.domain
      - text: Set the tenant default domain to {domain}.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-domains/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom domain's configuration and status
      effect: read
      questions:
      - Has my custom domain finished verification yet?
      - What DNS records does a specific custom domain need?
      instructions:
      - text: Show me custom domain {id}.
        slots:
          id: path.id
      - text: Check the verification status of custom domain {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-domains/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom domain
      effect: destructive
      questions:
      - How do I stop serving login from a custom domain?
      - What happens to requests when I delete a custom domain?
      instructions:
      - text: Delete custom domain {id}.
        slots:
          id: path.id
      - text: Remove custom domain {id} and stop serving requests on it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-domains/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom domain's TLS or client IP header
      effect: write
      questions:
      - Can I change the TLS policy on an existing custom domain?
      - How do I set the header my proxy uses to pass the real client IP?
      instructions:
      - text: Set the TLS policy of custom domain {id} to {tls_policy}.
        slots:
          id: path.id
          tls_policy: requestBody.tls_policy
      - text: Use {custom_client_ip_header} as the client IP header on domain {id}.
        slots:
          custom_client_ip_header: requestBody.custom_client_ip_header
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-domains/{id}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a custom domain
      effect: write
      questions:
      - Is there a way to run a test against my custom domain to see if it is serving correctly?
      - Can I check a verified custom domain is actually working?
      instructions:
      - text: Run the test process on custom domain {id}.
        slots:
          id: path.id
      - text: Test whether custom domain {id} is serving requests.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-domains/{id}/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a custom domain's DNS
      effect: write
      questions:
      - I added the DNS record; how do I trigger verification of my custom domain?
      - How long after verification does a custom domain start accepting requests?
      instructions:
      - text: Verify custom domain {id}.
        slots:
          id: path.id
      - text: Run DNS verification for custom domain {id} now.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'