WhoisFreaks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WhoisFreaks Domain Availability API

3 actions 3 updates phrasing extends openapi/whoisfreaks-domain-availability-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['/v2.0/domain/availability'].get
$.paths['/v2.0/domain/availability'].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 Domain Availability API
  version: 1.0.0
extends: openapi/whoisfreaks-domain-availability-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['/v2.0/domain/availability'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a domain is available to register
      effect: read
      questions:
      - Is a particular domain name still available to register?
      - Can I get alternative TLD suggestions when my domain is taken?
      - What is the maximum number of TLD suggestions I can ask for?
      instructions:
      - text: Check whether {domain} is available.
        slots:
          domain: query.domain
      - text: Check {domain} and suggest {count} other TLDs, suggestions {sug}.
        slots:
          domain: query.domain
          count: query.count
          sug: query.sug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2.0/domain/availability'].post
  update:
    x-apievangelist-phrasing:
      intent: Check availability for a batch of domains
      effect: read
      questions:
      - Can I check availability for up to 100 domain names in one call?
      - How do I see which TLDs are free for the same base name in bulk?
      instructions:
      - text: Bulk check availability of {domainNames}.
        slots:
          domainNames: requestBody.domainNames
      - text: Check {domain} across TLDs {tld} in one bulk request.
        slots:
          domain: query.domain
          tld: requestBody.tld
      method: generated
      generated: '2026-10-01'