WhoisFreaks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WhoisFreaks Account API

4 actions 4 updates phrasing extends openapi/whoisfreaks-account-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['/v1.0/api-key/rotate'].get

$.paths['/v1.0/whoisapi/usage'].get

$.paths['/v3.4/status'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for WhoisFreaks Account API
  version: 1.0.0
extends: openapi/whoisfreaks-account-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['/v1.0/api-key/rotate'].get
  update:
    x-apievangelist-phrasing:
      intent: Rotate my API key
      effect: destructive
      questions:
      - How do I replace my WhoisFreaks API key with a new one?
      - Can I rotate a leaked API key so the old one stops working?
      instructions:
      - text: Rotate my API key and give me the new one.
      - text: Issue a fresh API key to replace my current key.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1.0/whoisapi/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my account credit usage
      effect: read
      questions:
      - How many API credits have I used so far?
      - What does my account usage look like this billing period?
      instructions:
      - text: Show my account usage and remaining credits.
      - text: Report how many lookups my account has consumed.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.4/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check freshness of downloadable database files
      effect: read
      questions:
      - When were the downloadable database files last updated?
      - Is there a public endpoint that tells me how fresh every data file is without an API key?
      instructions:
      - text: Show the freshness status of all downloadable database files.
      - text: List when each downloadable data file was last refreshed.
      method: generated
      generated: '2026-10-01'