Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Deploy API

4 actions 4 updates phrasing extends openapi/live-direct-marketing-online-deploy-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 4

$.info
$.paths['/api/admin/deploy'].get
$.paths['/api/admin/deploy'].post
$.paths['/api/admin/deploy/{jobId}'].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 Deploy API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-deploy-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: 3
- target: $.paths['/api/admin/deploy'].get
  update:
    x-apievangelist-phrasing:
      intent: List deploy jobs
      effect: read
      questions:
      - Which admin deploys have been run recently?
      - Where can I see the list of deploy jobs?
      instructions:
      - text: List the admin deploy jobs.
      - text: Show recent deployments.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue a new deploy
      effect: write
      questions:
      - How do I trigger a deploy from the admin API?
      - Can I enqueue a new deployment job?
      instructions:
      - text: Enqueue a new deploy.
      - text: Start a deployment job now.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/deploy/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a deploy job's status
      effect: read
      questions:
      - Has my deploy job finished or failed?
      - How do I check progress of one deployment?
      instructions:
      - text: Check the status of deploy job {jobId}.
        slots:
          jobId: path.jobId
      - text: Is deploy {jobId} done yet? Look it up.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'