WhoisFreaks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WhoisFreaks Databases - IP Geolocation API

5 actions 5 updates phrasing extends openapi/whoisfreaks-databases-ip-geolocation-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['/v3.3/status/snapshot/ip/country'].get
$.paths['/v3.3/download/snapshot/ip/country'].get
$.paths['/v3.3/status/snapshot/ip/city'].get
$.paths['/v3.3/download/snapshot/ip/city'].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 Geolocation API
  version: 1.0.0
extends: openapi/whoisfreaks-databases-ip-geolocation-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['/v3.3/status/snapshot/ip/country'].get
  update:
    x-apievangelist-phrasing:
      intent: Check IP-to-country snapshot status
      effect: read
      questions:
      - Is a new IP to country snapshot available yet?
      - Which dates can I download the IP-to-country database for?
      instructions:
      - text: Show the status of the IP to country snapshot.
      - text: Check when the IP-to-country database was last published.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.3/download/snapshot/ip/country'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the IP-to-country snapshot
      effect: read
      questions:
      - Can I download a full IP to country mapping database?
      - How do I get the IP-to-country file for a specific date?
      instructions:
      - text: Download the IP to country snapshot dated {date}.
        slots:
          date: query.date
      - text: Fetch the country-level IP geolocation database for {date}.
        slots:
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.3/status/snapshot/ip/city'].get
  update:
    x-apievangelist-phrasing:
      intent: Check IP-to-city snapshot status
      effect: read
      questions:
      - Has the IP to city database been refreshed recently?
      - What is the current status of the city-level IP snapshot?
      instructions:
      - text: Show the status of the IP to city snapshot.
      - text: Check whether a new IP-to-city database is ready.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.3/download/snapshot/ip/city'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the IP-to-city snapshot
      effect: read
      questions:
      - Can I download a city-level IP geolocation database for offline use?
      - How do I get the IP-to-city snapshot for a past date?
      instructions:
      - text: Download the IP to city snapshot dated {date}.
        slots:
          date: query.date
      - text: Fetch the city-level IP geolocation database for {date}.
        slots:
          date: query.date
      method: generated
      generated: '2026-10-01'