Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Observability / API Tests API

5 actions 5 updates phrasing extends openapi/live-direct-marketing-online-observability-api-tests-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 5

$.info
$.paths['/api/admin/api-tests/catalog'].get
$.paths['/api/admin/api-tests/run'].post
$.paths['/api/admin/api-tests/runs'].get
$.paths['/api/admin/api-tests/runs/{id}'].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 Observability / API Tests API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-observability-api-tests-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: 4
- target: $.paths['/api/admin/api-tests/catalog'].get
  update:
    x-apievangelist-phrasing:
      intent: List synthetic API test suites
      effect: read
      questions:
      - Which synthetic API test suites are available?
      - Can I see the catalog of health-check suites for the API?
      instructions:
      - text: List the synthetic API test suite catalog.
      - text: Show me every available API test suite.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/api-tests/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a synthetic API test suite
      effect: write
      questions:
      - How does a super admin kick off a synthetic API test suite?
      - Can I run the API smoke tests on demand?
      instructions:
      - text: Run a synthetic API test suite now.
      - text: Trigger the API smoke tests.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/api-tests/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent API test runs
      effect: read
      questions:
      - Did the last synthetic API test runs pass?
      - Can I filter recent test runs by suite?
      instructions:
      - text: List the last {limit} runs of suite {suite}.
        slots:
          limit: query.limit
          suite: query.suiteId
      - text: Show recent test runs for suite {suite}, {limit} at most.
        slots:
          limit: query.limit
          suite: query.suiteId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/api-tests/runs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one API test run
      effect: read
      questions:
      - Which checks failed in a specific synthetic test run?
      - Where do I see the details of one API test run?
      instructions:
      - text: Show details of API test run {id}.
        slots:
          id: path.id
      - text: Tell me what failed in test run {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'