Live Direct Marketing · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/api/development-pipeline/board'].get
$.paths['/api/development-pipeline/attention'].get
$.paths['/api/development-pipeline/prod-counter'].get
$.paths['/api/development-pipeline/ci-runs-per-merge'].get
$.paths['/api/development-pipeline/journal'].get
$.paths['/api/development-pipeline/journal/findings/{findingId}/create-issue'].post
$.paths['/api/development-pipeline/journal/findings'].post
$.paths['/api/development-pipeline/issues/{iid}/pause'].patch
$.paths['/api/development-pipeline/issues/priority-triage'].post
$.paths['/api/development-pipeline/issues/{iid}/priority'].patch
$.paths['/api/development-pipeline/issues/{iid}/model'].patch
$.paths['/api/development-pipeline/issues/{iid}/take-next'].patch
$.paths['/api/development-pipeline/issues/{iid}/close'].patch

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 API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-development-pipeline-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: 13
- target: $.paths['/api/development-pipeline/board'].get
  update:
    x-apievangelist-phrasing:
      intent: View the development delivery board
      effect: read
      questions:
      - Which issues are in queue, with agents, in merge or deploying right now?
      - Where can I see the four-stage delivery board?
      instructions:
      - text: Show the development pipeline board across all four stages.
      - text: Display what is in queue, agents, merge and deploy.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/attention'].get
  update:
    x-apievangelist-phrasing:
      intent: See what in the pipeline needs an owner
      effect: read
      questions:
      - Which red tasks, failed deploys or agent questions need my attention?
      - Are there findings without an issue or branches waiting for merge approval?
      instructions:
      - text: Show the needs-an-owner block and delivery strip.
      - text: List everything in the pipeline waiting on me.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/prod-counter'].get
  update:
    x-apievangelist-phrasing:
      intent: Count issues shipped to production
      effect: read
      questions:
      - How many issues have actually shipped to prod with a green smoke check?
      - What counts toward the IN PROD showcase?
      instructions:
      - text: Show the IN PROD counter of shipped issues.
      - text: List issues that reached production through the main pipeline.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/ci-runs-per-merge'].get
  update:
    x-apievangelist-phrasing:
      intent: Measure CI runs per merge
      effect: read
      questions:
      - How many CI runs does each merge take on average?
      - What is the CI-runs-per-merge KPI over the last few hours?
      instructions:
      - text: Compute CI runs per merge over the last {minutes} minutes.
        slots:
          minutes: query.minutes
      - text: Show the CI runs per merge KPI for a {minutes}-minute window.
        slots:
          minutes: query.minutes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/journal'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the tester journal
      effect: read
      questions:
      - What rules, roles and findings are in the tester journal?
      - Did the tester journal integrity gate pass?
      instructions:
      - text: Show the tester journal snapshot.
      - text: Fetch the journal findings and integrity gate status.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/journal/findings/{findingId}/create-issue'].post
  update:
    x-apievangelist-phrasing:
      intent: Open an issue from a journal finding
      effect: write
      questions:
      - How do I turn a tester journal finding into a tracked issue?
      - Can I file a finding that has no issue number into a specific project?
      instructions:
      - text: Create an issue from journal finding {findingId} in project {projectId}.
        slots:
          findingId: path.findingId
          projectId: requestBody.projectId
      - text: File finding {findingId} as a from::journal issue.
        slots:
          findingId: path.findingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/journal/findings'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a finding to the tester journal
      effect: write
      questions:
      - How do I append a new finding line to the tester journal?
      - Can an agent add a journal finding without rewriting the whole description?
      instructions:
      - text: Append the finding {line} to the tester journal.
        slots:
          line: requestBody.line
      - text: 'Log this line in journal Block 2: {line}.'
        slots:
          line: requestBody.line
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/issues/{iid}/pause'].patch
  update:
    x-apievangelist-phrasing:
      intent: Pause or unpause a development issue
      effect: write
      questions:
      - How do I stop agents from picking up an issue for now?
      - Can I remove the paused label from an issue?
      instructions:
      - text: Set paused to {paused} on issue {iid}.
        slots:
          paused: requestBody.paused
          iid: path.iid
      - text: Pause issue {iid} in project {projectId}.
        slots:
          iid: path.iid
          projectId: requestBody.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/issues/priority-triage'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign priorities to all unprioritized issues
      effect: write
      questions:
      - How do I give every open issue without a P label a priority?
      - Can I preview the priority triage before it changes anything?
      instructions:
      - text: Run priority triage on open issues in project {projectId}.
        slots:
          projectId: requestBody.projectId
      - text: Dry-run priority triage with dryRun {dryRun}.
        slots:
          dryRun: requestBody.dryRun
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/issues/{iid}/priority'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set an issue's priority
      effect: write
      questions:
      - How do I mark an issue P1-critical?
      - Which priority levels can a development issue have?
      instructions:
      - text: Set issue {iid} to priority {priority}.
        slots:
          iid: path.iid
          priority: requestBody.priority
      - text: Mark issue {iid} as P3-ux.
        slots:
          iid: path.iid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/issues/{iid}/model'].patch
  update:
    x-apievangelist-phrasing:
      intent: Choose the model that works an issue
      effect: write
      questions:
      - How do I change which executor model handles an issue?
      - Which executor models can I assign to a development issue?
      instructions:
      - text: Assign executor model {model} to issue {iid}.
        slots:
          model: requestBody.model
          iid: path.iid
      - text: Have opus work issue {iid} instead of the default.
        slots:
          iid: path.iid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/issues/{iid}/take-next'].patch
  update:
    x-apievangelist-phrasing:
      intent: Move an issue to the front of the queue
      effect: write
      questions:
      - How do I make an issue the very next thing agents pick up?
      - Can I unpause an issue and bump it to P1 in one step?
      instructions:
      - text: Take issue {iid} next.
        slots:
          iid: path.iid
      - text: Unpause issue {iid} and put it at the front of the queue.
        slots:
          iid: path.iid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/development-pipeline/issues/{iid}/close'].patch
  update:
    x-apievangelist-phrasing:
      intent: Close an issue on the owner's behalf
      effect: destructive
      questions:
      - How do I close a development issue as the owner with an audit trail?
      - What label is added when an owner closes an issue?
      instructions:
      - text: Close issue {iid} as owner.
        slots:
          iid: path.iid
      - text: Close issue {iid} in project {projectId} with a closed-by-owner comment.
        slots:
          iid: path.iid
          projectId: requestBody.projectId
      method: generated
      generated: '2026-10-01'