Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Share Public API

4 actions 4 updates phrasing extends openapi/live-direct-marketing-online-share-public-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/share-og/{code}'].get
$.paths['/api/s/{code}'].get
$.paths['/api/share-public/{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 Share Public API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-share-public-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/share-og/{code}'].get
  update:
    x-apievangelist-phrasing:
      intent: Render link-preview meta tags for a share code
      effect: read
      questions:
      - What social preview HTML do crawlers see for a shared short link?
      - Can I get the Open Graph meta tags for a shared item by its short code?
      instructions:
      - text: Render Open Graph HTML for share code {code}.
        slots:
          code: path.code
      - text: Get the link-preview meta tags for short code {code}.
        slots:
          code: path.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/s/{code}'].get
  update:
    x-apievangelist-phrasing:
      intent: Open a shared item by short code
      effect: read
      questions:
      - Can someone without an account open a shared item from its short link?
      - What does a public short share code resolve to?
      instructions:
      - text: Get the shared item for short code {code}.
        slots:
          code: path.code
      - text: Open public share {code}.
        slots:
          code: path.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/share-public/{token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Open a shared item by legacy full token
      effect: read
      questions:
      - Do the old long share links with a full token still work?
      - Can I resolve a shared item from a legacy share token?
      instructions:
      - text: Get the shared item for legacy token {token}.
        slots:
          token: path.token
      - text: Open the older full-token share {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'