Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare DNS DNSSEC API

4 actions 4 updates phrasing extends openapi/cloudflare-dnssec-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Cloudflare's API. It is a proposal applied on top of the contract, not a document Cloudflare publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/zones/{zone_id}/dnssec'].get

$.paths['/zones/{zone_id}/dnssec'].delete

$.paths['/zones/{zone_id}/dnssec'].patch

OpenAPI Overlay

# 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 DNSSEC API
  version: 1.0.0
extends: openapi/cloudflare-dnssec-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: 3
- target: $.paths['/zones/{zone_id}/dnssec'].get
  update:
    x-apievangelist-phrasing:
      intent: View a zone's DNSSEC status and DS record
      effect: read
      questions:
      - Is DNSSEC turned on for my domain?
      - Where do I find the DS record to give my registrar?
      instructions:
      - text: Show the DNSSEC settings for zone {zone_id}.
        slots:
          zone_id: path.zone_id
      - text: Get the DS record and algorithm for {zone_id}.
        slots:
          zone_id: path.zone_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{zone_id}/dnssec'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove DNSSEC from a zone
      effect: destructive
      questions:
      - How do I delete the DNSSEC configuration from a zone?
      - Can I wipe DNSSEC entirely before moving my domain?
      instructions:
      - text: Delete the DNSSEC configuration for zone {zone_id}.
        slots:
          zone_id: path.zone_id
      - text: Remove DNSSEC records entirely from {zone_id}.
        slots:
          zone_id: path.zone_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{zone_id}/dnssec'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable DNSSEC on a zone
      effect: write
      questions:
      - Can I switch DNSSEC on for my zone?
      - What status values can I set to turn DNSSEC off?
      instructions:
      - text: Enable DNSSEC on zone {zone_id}.
        slots:
          zone_id: path.zone_id
      - text: Set the DNSSEC status of {zone_id} to {status}.
        slots:
          zone_id: path.zone_id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'