Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Tracking / Redirect Source API

7 actions 7 updates phrasing extends openapi/live-direct-marketing-online-tracking-redirect-source-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 7

$.info
$.paths['/api/redirect-sources'].get
$.paths['/api/redirect-sources'].post
$.paths['/api/redirect-sources/stats'].get
$.paths['/api/redirect-sources/{id}'].get
$.paths['/api/redirect-sources/{id}'].put
$.paths['/api/redirect-sources/{id}'].delete

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 Tracking / Redirect Source API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-tracking-redirect-source-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: 6
- target: $.paths['/api/redirect-sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List redirect sources
      effect: read
      questions:
      - Which redirect sources do I have for link tracking?
      - Can I filter redirect sources by category or status?
      instructions:
      - text: List redirect sources in category {category}.
        slots:
          category: query.category
      - text: Search redirect sources for {search}.
        slots:
          search: query.search
      - text: Show redirect sources with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/redirect-sources'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a redirect source
      effect: write
      questions:
      - How do I add a new redirect source for tracked links?
      - Can I register another domain to use for link redirects?
      instructions:
      - text: Create a new redirect source.
      - text: Add a redirect source for my tracked links.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/redirect-sources/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get redirect source statistics
      effect: read
      questions:
      - What are the overall stats for my redirect sources?
      - How many redirect sources are active versus not?
      instructions:
      - text: Show redirect source statistics.
      - text: Summarize my redirect sources in numbers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/redirect-sources/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a redirect source
      effect: read
      questions:
      - Can I view the details of one redirect source?
      - What is configured on a specific redirect source?
      instructions:
      - text: Get redirect source {id}.
        slots:
          id: path.id
      - text: Show the details of redirect source {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/redirect-sources/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a redirect source
      effect: write
      questions:
      - Can I change an existing redirect source?
      - How do I edit a redirect source I already made?
      instructions:
      - text: Update redirect source {id}.
        slots:
          id: path.id
      - text: Replace the settings of redirect source {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/redirect-sources/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a redirect source
      effect: destructive
      questions:
      - How do I remove a redirect source I no longer use?
      - Can I delete a redirect source?
      instructions:
      - text: Delete redirect source {id}.
        slots:
          id: path.id
      - text: Remove redirect source {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'