# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cloudflare DNS DNS Records API
  version: 1.0.0
extends: openapi/cloudflare-dns-records-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['/zones/{zone_id}/dns_records'].get
  update:
    x-apievangelist-phrasing:
      intent: List and filter a zone's DNS records
      effect: read
      questions:
      - How do I see every DNS record configured on my domain?
      - Can I filter a zone's DNS records down to just the MX or TXT ones?
      - Which DNS records in my zone point at a particular IP address?
      instructions:
      - text: List all DNS records in zone {zone}.
        slots:
          zone: path.zone_id
      - text: Show only the {type} records in zone {zone}.
        slots:
          type: query.type
          zone: path.zone_id
      - text: Find DNS records in zone {zone} whose content is {content}.
        slots:
          zone: path.zone_id
          content: query.content
      - text: Look up records named {name} in zone {zone}, {per_page} per page.
        slots:
          name: query.name
          zone: path.zone_id
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{zone_id}/dns_records'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new DNS record to a zone
      effect: write
      questions:
      - How do I add a new A record for a subdomain on Cloudflare?
      - Can I create a CNAME on a name that already has an A record?
      - What priority do I need to set when adding a new MX record?
      instructions:
      - text: Add a new {type} record {name} pointing to {content} in zone {zone}.
        slots:
          type: requestBody.type
          name: requestBody.name
          content: requestBody.content
          zone: path.zone_id
      - text: 'Create a proxied A record for {name} with value {content} in zone {zone}; proxied: {proxied}.'
        slots:
          name: requestBody.name
          content: requestBody.content
          zone: path.zone_id
          proxied: requestBody.proxied
      - text: Add a new MX record {name} to {content} with priority {priority} in zone {zone}.
        slots:
          name: requestBody.name
          content: requestBody.content
          priority: requestBody.priority
          zone: path.zone_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{zone_id}/dns_records/{dns_record_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of one DNS record
      effect: read
      questions:
      - How can I view the full settings of a single DNS record by its ID?
      - Is a specific DNS record currently proxied, and what TTL does it have?
      instructions:
      - text: Show me DNS record {record} in zone {zone}.
        slots:
          record: path.dns_record_id
          zone: path.zone_id
      - text: Check the TTL and proxy status of record {record} in zone {zone}.
        slots:
          record: path.dns_record_id
          zone: path.zone_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{zone_id}/dns_records/{dns_record_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a DNS record entirely
      effect: write
      questions:
      - How do I completely replace an existing DNS record with new values?
      - Do I have to resend every field when overwriting a DNS record rather than patching it?
      instructions:
      - text: Overwrite record {record} in zone {zone} with a {type} record {name} pointing to {content}.
        slots:
          record: path.dns_record_id
          zone: path.zone_id
          type: requestBody.type
          name: requestBody.name
          content: requestBody.content
      - text: Fully replace DNS record {record} in zone {zone}, setting every field with TTL {ttl}.
        slots:
          record: path.dns_record_id
          zone: path.zone_id
          ttl: requestBody.ttl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{zone_id}/dns_records/{dns_record_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DNS record from a zone
      effect: destructive
      questions:
      - How do I remove a DNS record I no longer need?
      - Can I delete one specific DNS record without touching the rest of the zone?
      instructions:
      - text: Delete DNS record {record} from zone {zone}.
        slots:
          record: path.dns_record_id
          zone: path.zone_id
      - text: Remove the stale record {record} in zone {zone}.
        slots:
          record: path.dns_record_id
          zone: path.zone_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{zone_id}/dns_records/{dns_record_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change selected fields on a DNS record
      effect: write
      questions:
      - How do I turn the orange-cloud proxy on or off for just one existing record?
      - Can I change only the TTL of an existing DNS record and leave everything else as is?
      - Is it possible to add a comment or tags to a DNS record I already created?
      instructions:
      - text: Set proxied to {proxied} on existing record {record} in zone {zone}, leaving other fields alone.
        slots:
          proxied: requestBody.proxied
          record: path.dns_record_id
          zone: path.zone_id
      - text: Change just the content of record {record} in zone {zone} to {content}.
        slots:
          record: path.dns_record_id
          zone: path.zone_id
          content: requestBody.content
      - text: Add the comment {comment} to existing DNS record {record} in zone {zone}.
        slots:
          comment: requestBody.comment
          record: path.dns_record_id
          zone: path.zone_id
      method: generated
      generated: '2026-09-26'