API Evangelist conversational phrasing for Netlify's API documentation Dns Zone API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Netlify's API documentation Dns Zone API
  version: 1.0.0
extends: openapi/netlify-dnszone-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: 11
- target: $.paths['/sites/{site_id}/dns'].get
  update:
    x-apievangelist-phrasing:
      intent: Get DNS zones for a site
      effect: read
      questions:
      - Which DNS zones are connected to my site?
      - Can I see the DNS setup for a specific site?
      instructions:
      - text: Show the DNS configuration for site {site}.
        slots:
          site: path.site_id
      - text: Get DNS zones used by site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/dns'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure Netlify DNS for a site
      effect: write
      questions:
      - How do I set up Netlify DNS for my site's domain?
      - Can I have DNS configured automatically for a site?
      instructions:
      - text: Configure DNS for site {site}.
        slots:
          site: path.site_id
      - text: Set up managed DNS zones for site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns_zones'].get
  update:
    x-apievangelist-phrasing:
      intent: List DNS zones
      effect: read
      questions:
      - What DNS zones do I manage?
      - Can I list only the DNS zones belonging to one team?
      instructions:
      - text: List all my DNS zones.
      - text: List DNS zones for team {account}.
        slots:
          account: query.account_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns_zones'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a DNS zone
      effect: write
      questions:
      - Can I create a DNS zone for a domain and link it to a site?
      - How do I start managing a new domain's DNS?
      instructions:
      - text: Create a DNS zone for domain {name}.
        slots:
          name: requestBody.name
      - text: Create DNS zone {name} in team {account} for site {site}.
        slots:
          name: requestBody.name
          account: requestBody.account_slug
          site: requestBody.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns_zones/{zone_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DNS zone
      effect: read
      questions:
      - Can I view the details of one DNS zone?
      - What nameservers are assigned to my DNS zone?
      instructions:
      - text: Get DNS zone {zone}.
        slots:
          zone: path.zone_id
      - text: Show details and nameservers for DNS zone {zone}.
        slots:
          zone: path.zone_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns_zones/{zone_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DNS zone
      effect: destructive
      questions:
      - How do I stop managing a domain's DNS and remove its zone?
      - Does deleting a DNS zone remove all its records?
      instructions:
      - text: Delete DNS zone {zone}.
        slots:
          zone: path.zone_id
      - text: Remove DNS zone {zone} entirely.
        slots:
          zone: path.zone_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns_zones/{zone_id}/transfer'].put
  update:
    x-apievangelist-phrasing:
      intent: Transfer a DNS zone to another team
      effect: write
      questions:
      - Can I move a DNS zone from one team to another?
      - Which user needs to receive a transferred DNS zone?
      instructions:
      - text: Transfer DNS zone {zone} from account {from} to account {to} for user {user}.
        slots:
          zone: path.zone_id
          from: query.account_id
          to: query.transfer_account_id
          user: query.transfer_user_id
      - text: Hand DNS zone {zone} over to team {to}, owned by user {user}, from account {from}.
        slots:
          zone: path.zone_id
          from: query.account_id
          to: query.transfer_account_id
          user: query.transfer_user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns_zones/{zone_id}/dns_records'].get
  update:
    x-apievangelist-phrasing:
      intent: List records in a DNS zone
      effect: read
      questions:
      - What DNS records are in my zone?
      - Can I see all A, CNAME and MX records for a domain?
      instructions:
      - text: List all DNS records in zone {zone}.
        slots:
          zone: path.zone_id
      - text: Show every record configured in DNS zone {zone}.
        slots:
          zone: path.zone_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns_zones/{zone_id}/dns_records'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a DNS record
      effect: write
      questions:
      - How do I add a CNAME or TXT record to my domain?
      - Can I set TTL and priority when creating an MX record?
      instructions:
      - text: Add a {type} record for {hostname} pointing to {value} in zone {zone}.
        slots:
          type: requestBody.type
          hostname: requestBody.hostname
          value: requestBody.value
          zone: path.zone_id
      - text: Create an MX record in zone {zone} for {hostname} to {value} with priority {priority}.
        slots:
          zone: path.zone_id
          hostname: requestBody.hostname
          value: requestBody.value
          priority: requestBody.priority
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns_zones/{zone_id}/dns_records/{dns_record_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single DNS record
      effect: read
      questions:
      - Can I look up one specific DNS record's value?
      - What TTL is set on a particular record?
      instructions:
      - text: Get DNS record {record} in zone {zone}.
        slots:
          record: path.dns_record_id
          zone: path.zone_id
      - text: Show the value and TTL of record {record} in zone {zone}.
        slots:
          record: path.dns_record_id
          zone: path.zone_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dns_zones/{zone_id}/dns_records/{dns_record_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DNS record
      effect: destructive
      questions:
      - How do I remove an outdated DNS record?
      - Can I delete a single record without deleting the zone?
      instructions:
      - text: Delete DNS record {record} from zone {zone}.
        slots:
          record: path.dns_record_id
          zone: path.zone_id
      - text: Remove record {record} in DNS zone {zone}.
        slots:
          record: path.dns_record_id
          zone: path.zone_id
      method: generated
      generated: '2026-09-26'