Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online DSAR API

5 actions 5 updates phrasing extends openapi/live-direct-marketing-online-dsar-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/dsar'].get
$.paths['/api/dsar'].post
$.paths['/api/dsar/lookup'].get
$.paths['/api/dsar/{id}/resolve'].post

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 DSAR API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-dsar-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/dsar'].get
  update:
    x-apievangelist-phrasing:
      intent: List data-subject requests
      effect: read
      questions:
      - Which GDPR data-subject requests are still open?
      - Can a super admin page through the data-subject request registry by status?
      instructions:
      - text: List {status} data-subject requests, page {page}, {limit} per page.
        slots:
          status: query.status
          page: query.page
          limit: query.limit
      - text: Show data-subject requests with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dsar'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a data-subject request
      effect: destructive
      questions:
      - How does someone ask for their personal data to be erased?
      - Is an erasure request applied immediately?
      instructions:
      - text: Submit a data-subject erasure request for me.
      - text: File a new data-subject request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dsar/lookup'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a data subject by email
      effect: read
      questions:
      - Is a given email address globally suppressed?
      - What data-subject requests has a person made before?
      instructions:
      - text: Look up data subject {email}.
        slots:
          email: query.email
      - text: Check suppression status and request history for {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dsar/{id}/resolve'].post
  update:
    x-apievangelist-phrasing:
      intent: Resolve a data-subject request
      effect: write
      questions:
      - How do I mark a data-subject request as handled?
      - Can a super admin close out a DSAR?
      instructions:
      - text: Resolve data-subject request {id}.
        slots:
          id: path.id
      - text: Mark DSAR {id} as resolved.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'