Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online OAUTH Tests API

4 actions 4 updates phrasing extends openapi/live-direct-marketing-online-oauth-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 4

$.info
$.paths['/api/v1/oauth/tests'].get
$.paths['/api/v1/oauth/tests'].post
$.paths['/api/v1/oauth/tests/{token}'].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 OAUTH Tests API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-oauth-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: 3
- target: $.paths['/api/v1/oauth/tests'].get
  update:
    x-apievangelist-phrasing:
      intent: List my completed deliverability tests
      effect: read
      questions:
      - Which deliverability tests have I finished, newest first?
      - Can I limit how many of my past inbox tests come back?
      instructions:
      - text: List my completed deliverability tests.
      - text: Show my last {limit} finished deliverability tests.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/oauth/tests'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a deliverability test
      effect: write
      questions:
      - How do I start an inbox placement test for an email I'm about to send?
      - Which seed addresses should I add to my message for a deliverability test?
      instructions:
      - text: Create a deliverability test and give me the seed addresses.
      - text: Start a deliverability test against providers {providers}.
        slots:
          providers: requestBody.providers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/oauth/tests/{token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one deliverability test result
      effect: read
      questions:
      - Where did my test email land for each mailbox provider?
      - Can I look up a single deliverability test by its token?
      instructions:
      - text: Show deliverability test {token}.
        slots:
          token: path.token
      - text: Get the placement results for test {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'