# 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 Workers API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-workers-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/workers/jobs/claim'].post
  update:
    x-apievangelist-phrasing:
      intent: Claim the next worker job
      effect: write
      questions:
      - How does a worker pick up its next job from the queue?
      - Where does a background worker claim work?
      instructions:
      - text: Claim the next available worker job.
      - text: Grab a job from the worker queue.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/workers/jobs/{id}/heartbeat'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a heartbeat for a running worker job
      effect: write
      questions:
      - How does a worker show a long job is still running?
      - Can a worker keep its claim on a job alive?
      instructions:
      - text: Send a heartbeat for worker job {id}.
        slots:
          id: path.id
      - text: Keep job {id} alive.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/workers/jobs/{id}/screenshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a screenshot for a worker job
      effect: write
      questions:
      - How does a worker attach a screenshot to a job?
      - Can I tag a job screenshot with its placement and variant?
      instructions:
      - text: Upload a screenshot for job {id}.
        slots:
          id: path.id
      - text: Attach the {placement} screenshot, variant {variant}, to job {id}.
        slots:
          placement: query.placement
          variant: query.variant
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/workers/jobs/{id}/complete'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a worker job complete
      effect: write
      questions:
      - How does a worker report that a job finished successfully?
      - Where do I submit a completed job's result?
      instructions:
      - text: Mark worker job {id} complete.
        slots:
          id: path.id
      - text: Report job {id} as finished.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/workers/jobs/{id}/fail'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a worker job failed
      effect: write
      questions:
      - How does a worker report that a job failed?
      - Can a worker give up on a job it claimed?
      instructions:
      - text: Mark worker job {id} as failed.
        slots:
          id: path.id
      - text: Report a failure on job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'