WhoisFreaks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WhoisFreaks Databases - IP WHOIS API

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

$.info
$.paths['/v3.3/download/snapshot/ip/whois'].get
$.paths['/v3.3/status/snapshot/ip/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 - IP WHOIS API
  version: 1.0.0
extends: openapi/whoisfreaks-databases-ip-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: 2
- target: $.paths['/v3.3/download/snapshot/ip/whois'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the IP WHOIS snapshot
      effect: read
      questions:
      - Can I download WHOIS data for all IP ranges as a file?
      - How do I get the IP WHOIS snapshot from a specific date?
      instructions:
      - text: Download the IP WHOIS snapshot dated {date}.
        slots:
          date: query.date
      - text: Fetch the bulk IP WHOIS database for {date}.
        slots:
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.3/status/snapshot/ip/whois'].get
  update:
    x-apievangelist-phrasing:
      intent: Check IP WHOIS snapshot status
      effect: read
      questions:
      - Is a new IP WHOIS snapshot ready to download?
      - What is the publication status of the IP WHOIS database?
      instructions:
      - text: Show the status of the IP WHOIS snapshot.
      - text: Check when the IP WHOIS database was last updated.
      method: generated
      generated: '2026-10-01'