Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Account API

6 actions 6 updates phrasing extends openapi/live-direct-marketing-online-account-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/v1/me'].get

$.paths['/api/account/api-keys'].get

$.paths['/api/account/api-keys'].post

$.paths['/api/account/dashboard'].get

$.paths['/api/account/api-keys/{id}'].delete

OpenAPI Overlay

# 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 Account API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-account-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/v1/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my API key's tier and usage
      effect: read
      questions:
      - How much of my daily and monthly quota have I used with this key?
      - What tier and scopes does the API key I'm calling with have?
      instructions:
      - text: Show this key's tier, scopes and current usage.
      - text: Check my remaining quota before I run a batch.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/api-keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List my API keys
      effect: read
      questions:
      - Which API keys exist on my account?
      - Can I see all the keys I've created in the portal?
      instructions:
      - text: List all API keys on my account.
      - text: Show my account's API keys.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/api-keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API key
      effect: write
      questions:
      - How do I generate a new API key for my account?
      - Can I create a key that is allowed to write monitoring data?
      instructions:
      - text: Create an API key named {name}.
        slots:
          name: requestBody.name
      - text: Create key {name} with monitoring write set to {monitoringWrite}.
        slots:
          name: requestBody.name
          monitoringWrite: requestBody.monitoringWrite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/dashboard'].get
  update:
    x-apievangelist-phrasing:
      intent: View the account dashboard
      effect: read
      questions:
      - What does my portal dashboard show about usage and recent tests?
      - Can I see my provider mix and usage chart in one place?
      instructions:
      - text: Show my account dashboard with usage and recent tests.
      - text: Get my portal usage chart and provider mix.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/api-keys/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an API key
      effect: destructive
      questions:
      - How do I revoke an API key I no longer trust?
      - Can I permanently disable one of my keys?
      instructions:
      - text: Revoke API key {id}.
        slots:
          id: path.id
      - text: Disable my key {id} now.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'