WhoisFreaks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WhoisFreaks DNS API

5 actions 5 updates phrasing extends openapi/whoisfreaks-dns-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for WhoisFreaks's API. It is a proposal applied on top of the contract, not a document WhoisFreaks publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v2.0/dns/live'].get
$.paths['/v2.0/dns/historical'].get
$.paths['/v2.1/dns/reverse'].get
$.paths['/v2.0/dns/bulk/live'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for WhoisFreaks DNS API
  version: 1.0.0
extends: openapi/whoisfreaks-dns-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: 4
- target: $.paths['/v2.0/dns/live'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up current DNS records
      effect: read
      questions:
      - What are the current MX and TXT records for a domain?
      - Can I do a live PTR lookup on an IP address?
      - Which record types can I request in one live DNS query?
      instructions:
      - text: Look up the live {type} records for {domainName}.
        slots:
          type: query.type
          domainName: query.domainName
      - text: Do a live PTR lookup on IP {ipAddress} with type {type}.
        slots:
          ipAddress: query.ipAddress
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2.0/dns/historical'].get
  update:
    x-apievangelist-phrasing:
      intent: Get historical DNS records for a domain
      effect: read
      questions:
      - How can I see what DNS records a domain used to have?
      - Can I page through a domain's past A records 100 at a time?
      instructions:
      - text: Show historical {type} records for {domainName}.
        slots:
          type: query.type
          domainName: query.domainName
      - text: Get page {page} of past {type} DNS history for {domainName}.
        slots:
          page: query.page
          type: query.type
          domainName: query.domainName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2.1/dns/reverse'].get
  update:
    x-apievangelist-phrasing:
      intent: Find domains by IP or DNS record value
      effect: read
      questions:
      - Which domains point to a given IP address?
      - Can I find every domain that uses a particular mail server or CIDR range?
      - Is there an exact-match option when reverse searching DNS values?
      instructions:
      - text: Find domains whose {type} records point to {value}.
        slots:
          type: query.type
          value: query.value
      - text: Reverse DNS search {type} records for {value} with exact match {exact}, page {page}.
        slots:
          value: query.value
          type: query.type
          page: query.page
          exact: query.exact
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2.0/dns/bulk/live'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up DNS for many domains and IPs at once
      effect: read
      questions:
      - Can I check DNS records for a hundred domains in one request?
      - How do I run live DNS lookups for a batch of IP addresses?
      instructions:
      - text: Bulk look up {type} records for domains {domainNames}.
        slots:
          type: query.type
          domainNames: requestBody.domainNames
      - text: Run a batch DNS query of type {type} on IPs {ipAddresses}.
        slots:
          type: query.type
          ipAddresses: requestBody.ipAddresses
      method: generated
      generated: '2026-10-01'