WhoisFreaks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WhoisFreaks Databases - Expiring & Dropped API

6 actions 6 updates phrasing extends openapi/whoisfreaks-databases-expiring-dropped-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 6

$.info
$.paths['/v3.1/download/domainer/expired'].get
$.paths['/v3.1/download/domainer/expired/cleaned'].get
$.paths['/v3.1/download/domainer/dropped'].get
$.paths['/v3.1/domains/dropped'].get
$.paths['/v3.3/download/domainer/dropped/backlinks'].get

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 Databases - Expiring & Dropped API
  version: 1.0.0
extends: openapi/whoisfreaks-databases-expiring-dropped-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: 5
- target: $.paths['/v3.1/download/domainer/expired'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the expiring domains file
      effect: read
      questions:
      - Where can I get a list of domains that are about to expire?
      - Can I download expiring domains along with their WHOIS data?
      instructions:
      - text: Download the expiring domains file with the whois option set to {whois}.
        slots:
          whois: query.whois
      - text: Fetch expiring domains for {date} with whois set to {whois}.
        slots:
          date: query.date
          whois: query.whois
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.1/download/domainer/expired/cleaned'].get
  update:
    x-apievangelist-phrasing:
      intent: Download cleaned WHOIS for expiring domains
      effect: read
      questions:
      - Is there a cleaned, normalized WHOIS file for expiring domains?
      - How do I get the tidied-up WHOIS records of domains nearing expiry?
      instructions:
      - text: Download the latest cleaned WHOIS file for expiring domains.
      - text: Fetch the cleaned expiring-domains WHOIS file for {date}.
        slots:
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.1/download/domainer/dropped'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the dropped domains file
      effect: read
      questions:
      - Where do I download the list of domains that just dropped?
      - Can I get dropped domains as a downloadable file with WHOIS included?
      instructions:
      - text: Download the dropped domains file with whois set to {whois}.
        slots:
          whois: query.whois
      - text: Fetch dropped domains from {date} with whois set to {whois}.
        slots:
          date: query.date
          whois: query.whois
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.1/domains/dropped'].get
  update:
    x-apievangelist-phrasing:
      intent: List dropped domains as JSON
      effect: read
      questions:
      - Can I get dropped domains as a JSON response instead of a file download?
      - Which domains dropped today under a particular TLD?
      instructions:
      - text: Show me today's dropped domains as JSON.
      - text: List dropped domains in JSON for TLDs {tlds} on {date}.
        slots:
          tlds: query.tlds
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.3/download/domainer/dropped/backlinks'].get
  update:
    x-apievangelist-phrasing:
      intent: Download dropped domains that have backlinks
      effect: read
      questions:
      - Which recently dropped domains still have backlinks pointing at them?
      - Can I download dropped domains with backlink data for SEO research?
      instructions:
      - text: Download the latest dropped-with-backlinks file.
      - text: Fetch dropped domains with backlinks for {date}.
        slots:
          date: query.date
      method: generated
      generated: '2026-10-01'