Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Phantom Browser / Download API

6 actions 6 updates phrasing extends openapi/live-direct-marketing-online-phantom-browser-download-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 6

$.info
$.paths['/api/phantom-browser/sync'].post
$.paths['/api/phantom-browser/update/check'].get
$.paths['/api/phantom-browser/update/bundle'].get
$.paths['/api/phantom-browser/download/{platform}'].get
$.paths['/api/phantom-browser/logs'].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 Live Direct Marketing Online Phantom Browser / Download API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-phantom-browser-download-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: 5
- target: $.paths['/api/phantom-browser/sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync Phantom desktop profiles with a token
      effect: write
      questions:
      - How does the Phantom desktop client sync its browser profiles?
      - Can I sync Phantom profiles using the client token?
      instructions:
      - text: Sync Phantom profiles using token {x-phantom-token}.
        slots:
          x-phantom-token: header.x-phantom-token
      - text: Pull the latest Phantom client profiles with token {x-phantom-token}.
        slots:
          x-phantom-token: header.x-phantom-token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/update/check'].get
  update:
    x-apievangelist-phrasing:
      intent: Check for a Phantom client update
      effect: read
      questions:
      - Is there a newer version of the Phantom client available?
      - Does my Phantom build hash match the latest release?
      instructions:
      - text: Check for Phantom updates from version {version}.
        slots:
          version: query.version
      - text: See if Phantom version {version} with hash {hash} is out of date.
        slots:
          version: query.version
          hash: query.hash
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/update/bundle'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the Phantom update bundle
      effect: read
      questions:
      - Where do I get the gzipped update bundle for the Phantom client?
      - Can I download just the updated Phantom source files?
      instructions:
      - text: Download the Phantom client update bundle.
      - text: Fetch the gzipped Phantom update files.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/download/{platform}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the Phantom client installer
      effect: read
      questions:
      - How do I download the Phantom browser for my operating system?
      - Which platforms can I get the Phantom client binary for?
      instructions:
      - text: Download the Phantom client for {platform}.
        slots:
          platform: path.platform
      - text: Get the Phantom binary built for {platform}.
        slots:
          platform: path.platform
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/logs'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload logs from the Phantom client
      effect: write
      questions:
      - How does the Phantom desktop client report its logs?
      - Can I send Phantom client logs for troubleshooting?
      instructions:
      - text: Upload the Phantom client logs.
      - text: Send my Phantom desktop logs to the server.
      method: generated
      generated: '2026-10-01'