Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Domain Observations API

7 actions 7 updates phrasing extends openapi/live-direct-marketing-online-domainobservations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Live Direct Marketing's API. It is a proposal applied on top of the contract, not a document Live Direct Marketing publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/api/domain-observations/lookup'].get
$.paths['/api/domain-observations'].post
$.paths['/api/domain-observations/page/{domain}'].get
$.paths['/api/domain-observations/fallback'].get
$.paths['/api/domain-observations/data/{domain}'].get
$.paths['/api/domain-observations/catalog'].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 Live Direct Marketing Online Domain Observations API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-domainobservations-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: 6
- target: $.paths['/api/domain-observations/lookup'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up observations for a domain
      effect: read
      questions:
      - Are there any recorded observations for a given domain?
      - Can I quickly check whether a domain has been observed?
      instructions:
      - text: Look up domain observations for {domain}.
        slots:
          domain: query.domain
      - text: Check if {domain} has observations.
        slots:
          domain: query.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/domain-observations'].post
  update:
    x-apievangelist-phrasing:
      intent: Request domain observations
      effect: write
      questions:
      - How do I ask for a domain to start being observed?
      - Can I submit a new domain observation request?
      instructions:
      - text: Request observations for a new domain.
      - text: Submit a domain observation request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/domain-observations/page/{domain}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a domain's observation page for a date range
      effect: read
      questions:
      - What was observed about a domain between two dates?
      - Can I view a domain's observation page for a specific period?
      instructions:
      - text: Show the observation page for {domain} from {from} to {to}.
        slots:
          domain: path.domain
          from: query.from
          to: query.to
      - text: Get {domain} observations between {from} and {to}.
        slots:
          domain: path.domain
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/domain-observations/fallback'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the domain observations fallback page
      effect: read
      questions:
      - What is shown when no specific domain observation page is available?
      - Is there a default domain observations page?
      instructions:
      - text: Show the domain observations fallback page.
      - text: Load the default observations page.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/domain-observations/data/{domain}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get raw observation data for a domain
      effect: read
      questions:
      - Can I get the underlying observation data for a domain rather than the page?
      - Where is the raw data behind a domain's observations?
      instructions:
      - text: Get raw observation data for {domain}.
        slots:
          domain: path.domain
      - text: Fetch the observation dataset for {domain}.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/domain-observations/catalog'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse the catalog of observed domains
      effect: read
      questions:
      - Which domains are in the observations catalog?
      - Can I page through every observed domain with a cursor?
      instructions:
      - text: List the observed domains catalog from cursor {cursor}.
        slots:
          cursor: query.cursor
      - text: Show the next page of observed domains after {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'