Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Browser Queue API

7 actions 7 updates phrasing extends openapi/live-direct-marketing-online-browser-queue-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/admin/browser-queue'].get
$.paths['/api/admin/browser-queue/jobs'].get
$.paths['/api/admin/browser-queue/{id}/cancel'].post
$.paths['/api/admin/browser-queue/{id}/retry'].post
$.paths['/api/admin/browser-queue/pause'].post
$.paths['/api/admin/browser-queue/resume'].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 Browser Queue API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-browser-queue-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/admin/browser-queue'].get
  update:
    x-apievangelist-phrasing:
      intent: View browser queue stats
      effect: read
      questions:
      - How busy is the browser job queue right now?
      - Is the browser queue sharing capacity fairly across tenants?
      instructions:
      - text: Show browser queue stats and the fair-share view.
      - text: Get the current browser queue load.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/browser-queue/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List browser queue jobs by status
      effect: read
      questions:
      - Which browser jobs are failed or still waiting?
      - Can I page through browser queue jobs with a given status?
      instructions:
      - text: List {status} browser queue jobs from {start} to {end}.
        slots:
          status: query.status
          start: query.start
          end: query.end
      - text: Show browser queue jobs in status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/browser-queue/{id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a browser queue job
      effect: destructive
      questions:
      - Can I cancel a stuck browser job?
      - How do I remove one job from the browser queue?
      instructions:
      - text: Cancel browser queue job {id}.
        slots:
          id: path.id
      - text: Stop browser job {id} from running.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/browser-queue/{id}/retry'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry a failed browser job
      effect: write
      questions:
      - Can I rerun a browser job that failed?
      - How do I put a failed job back on the browser queue?
      instructions:
      - text: Retry failed browser queue job {id}.
        slots:
          id: path.id
      - text: Requeue browser job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/browser-queue/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause the browser queue
      effect: write
      questions:
      - How do I stop the browser queue from picking up new jobs?
      - Can I pause all browser processing temporarily?
      instructions:
      - text: Pause the browser queue.
      - text: Halt browser job processing for now.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/browser-queue/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume the browser queue
      effect: write
      questions:
      - Can I restart a paused browser queue?
      - What gets browser jobs processing again after a pause?
      instructions:
      - text: Resume the browser queue.
      - text: Restart browser job processing.
      method: generated
      generated: '2026-10-01'