Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Development Pipeline…

6 actions 6 updates phrasing extends openapi/live-direct-marketing-online-development-pipeline-conveyor-bridge-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/development-pipeline/conveyor/issues'].post
$.paths['/api/development-pipeline/conveyor/issues/{num}/priority'].patch
$.paths['/api/development-pipeline/conveyor/issues/{num}/pause'].patch
$.paths['/api/development-pipeline/conveyor/issues/{num}/action'].post
$.paths['/api/development-pipeline/conveyor/template'].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 Development Pipeline…
  version: 1.0.0
extends: openapi/live-direct-marketing-online-development-pipeline-conveyor-bridge-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/development-pipeline/conveyor/issues'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a conveyor development task
      effect: write
      questions:
      - How do I file a new task on the development conveyor?
      - What happens if my task description is too vague?
      instructions:
      - text: 'Create a conveyor task: {description}.'
        slots:
          description: requestBody.description
      - text: File conveyor issue {description} at priority {priority}.
        slots:
          description: requestBody.description
          priority: requestBody.priority
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/conveyor/issues/{num}/priority'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set a conveyor task's priority
      effect: write
      questions:
      - Can I bump a conveyor task to P1?
      - Which priority levels can a conveyor task have?
      instructions:
      - text: Set conveyor task {num} to priority {priority}.
        slots:
          num: path.num
          priority: requestBody.priority
      - text: Make task {num} {priority} on the conveyor.
        slots:
          num: path.num
          priority: requestBody.priority
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/conveyor/issues/{num}/pause'].patch
  update:
    x-apievangelist-phrasing:
      intent: Pause or unpause a conveyor task
      effect: write
      questions:
      - Can I pause a conveyor task from the console?
      - How do I unpause a development task?
      instructions:
      - text: Set paused={paused} on conveyor task {num}.
        slots:
          num: path.num
          paused: requestBody.paused
      - text: 'Pause conveyor task {num}: {paused}.'
        slots:
          num: path.num
          paused: requestBody.paused
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/conveyor/issues/{num}/action'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry or cancel a stuck conveyor task
      effect: write
      questions:
      - Can I retry a conveyor task that's blocked or failed?
      - Is there a way to cancel a failed development task?
      instructions:
      - text: Apply {action} to blocked conveyor task {num}.
        slots:
          num: path.num
          action: requestBody.action
      - text: Run {action} on failed task {num}.
        slots:
          num: path.num
          action: requestBody.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/conveyor/template'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the conveyor task template and rules
      effect: read
      questions:
      - What rules and template does the development conveyor expect?
      - Where can I read the live pipeline docs for writing tasks?
      instructions:
      - text: Show the live conveyor task template and rules.
      - text: Get the pipeline rule docs from the conveyor bridge.
      method: generated
      generated: '2026-10-01'