Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Files / Serve API

5 actions 5 updates phrasing extends openapi/live-direct-marketing-online-files-serve-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/uploads/images/{tenantDbName}/{filename}'].get

$.paths['/api/uploads/tenant-assets/{tenantDbName}/{filename}'].get

$.paths['/api/uploads/dialog-attachments/{tenantDbName}/{filename}'].get

$.paths['/api/uploads/avatars/{filename}'].get

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 Files / Serve API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-files-serve-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/uploads/images/{tenantDbName}/{filename}'].get
  update:
    x-apievangelist-phrasing:
      intent: Serve an uploaded creative image
      effect: read
      questions:
      - What URL serves an uploaded creative image for a tenant?
      - Can I fetch a tenant's uploaded image by filename?
      instructions:
      - text: Serve image {filename} from tenant {tenantDbName}.
        slots:
          tenantDbName: path.tenantDbName
          filename: path.filename
      - text: Fetch uploaded creative image {filename} for {tenantDbName}.
        slots:
          tenantDbName: path.tenantDbName
          filename: path.filename
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/uploads/tenant-assets/{tenantDbName}/{filename}'].get
  update:
    x-apievangelist-phrasing:
      intent: Serve a tenant signature or photo asset
      effect: read
      questions:
      - How do I load a tenant's signature image or PDF photo?
      - Can I retrieve a tenant asset file by name?
      instructions:
      - text: Serve tenant asset {filename} for {tenantDbName}.
        slots:
          tenantDbName: path.tenantDbName
          filename: path.filename
      - text: Fetch the signature file {filename} of tenant {tenantDbName}.
        slots:
          tenantDbName: path.tenantDbName
          filename: path.filename
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/uploads/dialog-attachments/{tenantDbName}/{filename}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an inbound email attachment
      effect: read
      questions:
      - How do I download an attachment that came in on a reply?
      - Can I get a file attached to an inbound dialog message?
      instructions:
      - text: Download dialog attachment {filename} for {tenantDbName}.
        slots:
          tenantDbName: path.tenantDbName
          filename: path.filename
      - text: Fetch the inbound reply attachment {filename} from tenant {tenantDbName}.
        slots:
          tenantDbName: path.tenantDbName
          filename: path.filename
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/uploads/avatars/{filename}'].get
  update:
    x-apievangelist-phrasing:
      intent: Serve a user avatar
      effect: read
      questions:
      - Where are user avatar images served from?
      - Can I fetch a user's avatar by its filename?
      instructions:
      - text: Serve avatar {filename}.
        slots:
          filename: path.filename
      - text: Fetch user avatar image {filename}.
        slots:
          filename: path.filename
      method: generated
      generated: '2026-10-01'