# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Laravel Cloud Domains API
  version: 1.0.0
extends: openapi/laravel-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: 6
- target: $.paths['/environments/{environment}/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List domains attached to an environment
      effect: read
      questions:
      - Which custom domains point at my Laravel Cloud environment?
      - Can I find domains whose SSL certificate isn't active yet?
      instructions:
      - text: List the domains for environment {environment}.
        slots:
          environment: path.environment
      - text: Show environment {environment} domains with SSL status {ssl_status}.
        slots:
          environment: path.environment
          ssl_status: query.filter[ssl_status]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environment}/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a custom domain to an environment
      effect: write
      questions:
      - How do I attach my own domain to a cloud environment?
      - Can a new domain also redirect www and accept wildcard subdomains?
      instructions:
      - text: Add domain {name} to environment {environment}.
        slots:
          name: requestBody.name
          environment: path.environment
      - text: Attach {name} to environment {environment} with www redirect {www_redirect} and wildcard {wildcard_enabled}.
        slots:
          name: requestBody.name
          environment: path.environment
          www_redirect: requestBody.www_redirect
          wildcard_enabled: requestBody.wildcard_enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a domain's DNS and SSL status
      effect: read
      questions:
      - Which DNS records do I still need to add for my domain?
      - What hostname and SSL status does a specific domain have?
      instructions:
      - text: Show domain {domain}.
        slots:
          domain: path.domain
      - text: Get domain {domain} and re-check it while fetching, verify {verify}.
        slots:
          domain: path.domain
          verify: query.verify
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a domain from an environment
      effect: destructive
      questions:
      - How do I detach a domain I'm no longer using?
      - Can I delete a custom domain from my environment?
      instructions:
      - text: Delete domain {domain}.
        slots:
          domain: path.domain
      - text: Detach and remove the custom domain {domain}.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a domain's verification method
      effect: write
      questions:
      - Can I switch how my domain is verified after adding it?
      - Which setting can I change on an existing domain?
      instructions:
      - text: Switch domain {domain} to verification method {verification_method}.
        slots:
          domain: path.domain
          verification_method: requestBody.verification_method
      - text: Update domain {domain} to verify by {verification_method}.
        slots:
          domain: path.domain
          verification_method: requestBody.verification_method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain}/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a domain's DNS records
      effect: write
      questions:
      - I added the DNS records — how do I check they're set up correctly?
      - Can I trigger a DNS verification check for my domain now?
      instructions:
      - text: Verify the DNS records for domain {domain}.
        slots:
          domain: path.domain
      - text: Run a DNS check on {domain} now.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-10-01'