WhoisFreaks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WhoisFreaks Databases - WHOIS API

4 actions 4 updates phrasing extends openapi/whoisfreaks-databases-whois-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 4

$.info
$.paths['/v3.3/download/dbupdate/daily/domains/whois'].get
$.paths['/v3.3/download/dbupdate/weekly/domains/whois'].get
$.paths['/v3.3/download/dbupdate/monthly/domains/whois'].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 - WHOIS API
  version: 1.0.0
extends: openapi/whoisfreaks-databases-whois-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: 3
- target: $.paths['/v3.3/download/dbupdate/daily/domains/whois'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the daily domain WHOIS database update
      effect: read
      questions:
      - Where can I download each day's changed domain WHOIS records?
      - Can I get the daily WHOIS delta for a date last week?
      instructions:
      - text: Download the latest daily WHOIS database update.
      - text: Fetch the daily domain WHOIS update for {date}.
        slots:
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.3/download/dbupdate/weekly/domains/whois'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the weekly domain WHOIS database update
      effect: read
      questions:
      - Is there a weekly domain WHOIS database file to keep my copy in sync?
      - How do I get the WHOIS weekly update for a particular week?
      instructions:
      - text: Download this week's domain WHOIS database update.
      - text: Fetch the weekly WHOIS database file dated {date}.
        slots:
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.3/download/dbupdate/monthly/domains/whois'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the monthly domain WHOIS database update
      effect: read
      questions:
      - Can I download a monthly bulk dump of domain WHOIS records?
      - Which date gets me an older monthly WHOIS database file?
      instructions:
      - text: Download the most recent monthly WHOIS database file.
      - text: Fetch the monthly domain WHOIS database for {date}.
        slots:
          date: query.date
      method: generated
      generated: '2026-10-01'