Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Pipeline Events API

10 actions 10 updates phrasing extends openapi/live-direct-marketing-online-pipeline-events-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 10

$.info
$.paths['/api/pipeline/events'].post
$.paths['/api/pipeline/summary'].get
$.paths['/api/pipeline/speed'].get
$.paths['/api/pipeline/speed/stage/{name}/tasks'].get
$.paths['/api/pipeline/tasks'].get
$.paths['/api/pipeline/tasks/{id}'].get
$.paths['/api/pipeline/tasks/{id}/stage-timeline'].get
$.paths['/api/pipeline/steps/{id}/logs'].get
$.paths['/api/pipeline/files/{name}'].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 Pipeline Events API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-pipeline-events-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: 9
- target: $.paths['/api/pipeline/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Ingest a conveyor event from the orchestrator
      effect: write
      questions:
      - How does the orchestrator report task and step progress to the conveyor?
      - Can one event append a log line or upload a file snapshot?
      instructions:
      - text: Send a conveyor event of type {type}.
        slots:
          type: requestBody.type
      - text: Post a {type} event for task {task} and step {step}.
        slots:
          type: requestBody.type
          task: requestBody.task
          step: requestBody.step
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipeline/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarise conveyor tasks by status
      effect: read
      questions:
      - How many conveyor tasks are in each status right now?
      - How many tasks reached production per hour or per shift?
      instructions:
      - text: Show the conveyor task summary.
      - text: Count conveyor tasks by status and production throughput.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipeline/speed'].get
  update:
    x-apievangelist-phrasing:
      intent: Get conveyor lead time and throughput
      effect: read
      questions:
      - What's the 7-day and 30-day lead time for conveyor tasks?
      - Which conveyor stage is slowing work down?
      instructions:
      - text: Show the conveyor speed block, force refresh {force}.
        slots:
          force: query.force
      - text: Get conveyor lead time, throughput and WIP with force={force}.
        slots:
          force: query.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipeline/speed/stage/{name}/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List tasks in one conveyor stage
      effect: read
      questions:
      - Which tasks are sitting longest in a particular conveyor stage?
      - What tasks are in the review stage right now?
      instructions:
      - text: List tasks in conveyor stage {name} by time spent.
        slots:
          name: path.name
      - text: Show which tasks are stuck in stage {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipeline/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List conveyor tasks
      effect: read
      questions:
      - Which conveyor tasks are currently in progress?
      - Can I page through conveyor tasks filtered by status?
      instructions:
      - text: List conveyor tasks with status {status}, page {page} of size {pageSize}.
        slots:
          status: query.status
          page: query.page
          pageSize: query.pageSize
      - text: Show page {page} ({pageSize} per page) of {status} conveyor tasks.
        slots:
          page: query.page
          pageSize: query.pageSize
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipeline/tasks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a conveyor task with its steps
      effect: read
      questions:
      - What steps has a particular conveyor task gone through?
      - Can I see a conveyor task's details and steps together?
      instructions:
      - text: Show conveyor task {id} with its steps.
        slots:
          id: path.id
      - text: Open conveyor task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipeline/tasks/{id}/stage-timeline'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a task's per-stage timeline
      effect: read
      questions:
      - How long did one task spend in each stage from queued to prod?
      - Where did a specific conveyor task lose the most time?
      instructions:
      - text: Show the stage timeline of task {id}.
        slots:
          id: path.id
      - text: Break down time per stage for conveyor task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipeline/steps/{id}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a conveyor step's logs
      effect: read
      questions:
      - What did a particular conveyor step log while it ran?
      - Can I page through the logs of one step?
      instructions:
      - text: Show logs for step {id}, page {page} with {pageSize} rows.
        slots:
          id: path.id
          page: query.page
          pageSize: query.pageSize
      - text: Read page {page} of step {id}'s log, {pageSize} per page.
        slots:
          page: query.page
          id: path.id
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipeline/files/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a conveyor service file snapshot
      effect: read
      questions:
      - What do the conveyor's GATES.md or questions.md files currently say?
      - Can I read the latest snapshot of a conveyor service file?
      instructions:
      - text: Show the conveyor file {name}.
        slots:
          name: path.name
      - text: Fetch the snapshot of service file {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'