WhoisFreaks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WhoisFreaks IP Reputation API

3 actions 3 updates phrasing extends openapi/whoisfreaks-ip-reputation-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['/v1.0/security'].get
$.paths['/v1.0/security'].post

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 IP Reputation API
  version: 1.0.0
extends: openapi/whoisfreaks-ip-reputation-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['/v1.0/security'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an IP for VPN, proxy, Tor or bot activity
      effect: read
      questions:
      - Is this IP address a VPN, proxy or Tor exit node?
      - Can I tell whether a single IP belongs to a bot?
      instructions:
      - text: Check the security reputation of IP {ip}.
        slots:
          ip: query.ip
      - text: Tell me if {ip} is a proxy, VPN or Tor node.
        slots:
          ip: query.ip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1.0/security'].post
  update:
    x-apievangelist-phrasing:
      intent: Check reputation for a batch of IPs
      effect: read
      questions:
      - Can I screen up to 100 IP addresses for threats in one request?
      - How do I flag proxies and Tor nodes across a list of IPs?
      instructions:
      - text: Bulk check threat reputation for IPs {ips}.
        slots:
          ips: requestBody.ips
      - text: Screen the IP list {ips} for VPNs, proxies and bots.
        slots:
          ips: requestBody.ips
      method: generated
      generated: '2026-10-01'