Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Legal API

11 actions 11 updates phrasing extends openapi/live-direct-marketing-online-legal-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 11

$.info
$.paths['/api/legal/terms'].get
$.paths['/api/legal/terms'].put
$.paths['/api/legal/documents'].get
$.paths['/api/legal/documents/{key}'].get
$.paths['/api/legal/documents/{key}/publish'].post
$.paths['/api/legal/documents/{key}/versions'].get
$.paths['/api/legal/acceptances'].get
$.paths['/api/legal/acceptances'].post
$.paths['/api/legal/acceptances/me'].get
$.paths['/api/legal'].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 Legal API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-legal-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: 10
- target: $.paths['/api/legal/terms'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the current terms of service
      effect: read
      questions:
      - What do the current terms of service say?
      - Can I get the terms of service in English instead of Russian?
      instructions:
      - text: Get the current terms of service in {locale}.
        slots:
          locale: query.locale
      - text: Show me the terms of service text.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/legal/terms'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit the terms of service text
      effect: write
      questions:
      - How does a super admin change the terms of service wording?
      - Can I overwrite the current terms text directly?
      instructions:
      - text: Update the terms of service text.
      - text: Replace the wording of the current terms of service.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/legal/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List the public legal documents
      effect: read
      questions:
      - Which legal documents are published, like privacy policy or acceptable use?
      - Can I see a summary of each public legal document?
      instructions:
      - text: List the public legal documents with their summaries.
      - text: Show the titles of all published legal policies.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/legal/documents/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one legal document
      effect: read
      questions:
      - Can I read the privacy policy or the DPA?
      - Where is the campaign guarantee document?
      instructions:
      - text: Get the {key} legal document.
        slots:
          key: path.key
      - text: Show me the full text of legal document {key}.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/legal/documents/{key}/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a new version of a legal document
      effect: write
      questions:
      - How do I publish a new version of the privacy policy?
      - Can a super admin release an updated legal document version?
      instructions:
      - text: Publish a new version of legal document {key}.
        slots:
          key: path.key
      - text: Release an updated {key} policy.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/legal/documents/{key}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List versions of a legal document
      effect: read
      questions:
      - What earlier versions of a legal document exist?
      - Can I see the version history of the terms in one locale?
      instructions:
      - text: List versions of legal document {key}.
        slots:
          key: path.key
      - text: Show the {locale} version history of {key}.
        slots:
          locale: query.locale
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/legal/acceptances'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the legal acceptance registry
      effect: read
      questions:
      - Who accepted which version of a legal document, and when?
      - Can I filter acceptances by user, tenant or document?
      instructions:
      - text: Show acceptances of document {docKey}.
        slots:
          docKey: query.docKey
      - text: List every legal acceptance recorded by user {userId}.
        slots:
          userId: query.userId
      - text: Show acceptances for tenant {tenantId}.
        slots:
          tenantId: query.tenantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/legal/acceptances'].post
  update:
    x-apievangelist-phrasing:
      intent: Record my acceptance of a legal document
      effect: write
      questions:
      - How do I record that I accepted a specific legal document?
      - Can I accept the privacy policy or the AUP for my user?
      instructions:
      - text: Record my acceptance of this legal document.
      - text: Log that I agreed to the latest policy version.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/legal/acceptances/me'].get
  update:
    x-apievangelist-phrasing:
      intent: List my own legal acceptances
      effect: read
      questions:
      - Which legal documents have I already accepted?
      - When did I agree to each policy?
      instructions:
      - text: Show my own legal acceptances.
      - text: List the policies I personally have agreed to.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/legal'].get
  update:
    x-apievangelist-phrasing:
      intent: List all legal documents as an admin
      effect: read
      questions:
      - Can a super admin see every legal document including unpublished ones?
      - What does the full admin list of legal documents contain?
      instructions:
      - text: List all legal documents in the admin view.
      - text: Show every legal record for super admins.
      method: generated
      generated: '2026-10-01'