WhoisFreaks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WhoisFreaks WHOIS API

5 actions 5 updates phrasing extends openapi/whoisfreaks-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 5

$.info
$.paths['/v2.0/whois/live'].get
$.paths['/v2.0/bulkwhois/live'].post
$.paths['/v2.0/whois/history'].get
$.paths['/v2.0/whois/reverse'].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 WHOIS API
  version: 1.0.0
extends: openapi/whoisfreaks-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: 4
- target: $.paths['/v2.0/whois/live'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up current WHOIS for a domain
      effect: read
      questions:
      - Who currently owns a domain and when does it expire?
      - Can I query authoritative WHOIS servers in real time for one domain?
      instructions:
      - text: Look up the live WHOIS for {domainName}.
        slots:
          domainName: query.domainName
      - text: Get the current registrar and expiry date of {domainName}.
        slots:
          domainName: query.domainName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2.0/bulkwhois/live'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up WHOIS for many domains at once
      effect: read
      questions:
      - Can I run WHOIS on up to 100 domains in one request?
      - Am I charged for domains that fail in a bulk WHOIS lookup?
      instructions:
      - text: Run bulk WHOIS on {domainNames}.
        slots:
          domainNames: requestBody.domainNames
      - text: 'Get live WHOIS records for this batch of domains: {domainNames}.'
        slots:
          domainNames: requestBody.domainNames
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2.0/whois/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a domain's historical WHOIS records
      effect: read
      questions:
      - How has a domain's ownership changed over the years?
      - Can I see previous registrants of a domain?
      instructions:
      - text: Show the WHOIS history of {domainName}.
        slots:
          domainName: query.domainName
      - text: Get page {page} of past WHOIS records for {domainName}.
        slots:
          page: query.page
          domainName: query.domainName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2.0/whois/reverse'].get
  update:
    x-apievangelist-phrasing:
      intent: Find domains by a keyword in WHOIS records
      effect: read
      questions:
      - Which domains are registered by a given company or email?
      - What other domains share a registrant name with mine?
      instructions:
      - text: Reverse WHOIS search for {keyword}.
        slots:
          keyword: query.keyword
      - text: Find all domains whose WHOIS mentions {keyword}, page {page}.
        slots:
          keyword: query.keyword
          page: query.page
      method: generated
      generated: '2026-10-01'