Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Rules / Creative API

6 actions 6 updates phrasing extends openapi/live-direct-marketing-online-rules-creative-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 6

$.info
$.paths['/api/creatives/{id}/rules'].get
$.paths['/api/creatives/{id}/rules'].patch
$.paths['/api/creatives/{id}/rules/schema'].get
$.paths['/api/creatives/{id}/rules/context'].get
$.paths['/api/creatives/{id}/rules/history'].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 Rules / Creative API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-rules-creative-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: 5
- target: $.paths['/api/creatives/{id}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a creative's rules document
      effect: read
      questions:
      - What rules are set on a particular email creative?
      - Can I read the full rules document attached to a creative?
      instructions:
      - text: Get the rules for creative {id}.
        slots:
          id: path.id
      - text: Show the rules document of creative {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creatives/{id}/rules'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a creative's rules
      effect: write
      questions:
      - Can I edit just part of a creative's rules without replacing them all?
      - How do I tweak the rules on an email creative?
      instructions:
      - text: Patch the rules of creative {id}.
        slots:
          id: path.id
      - text: Update one setting in creative {id}'s rules document.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creatives/{id}/rules/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the JSON Schema for creative rules
      effect: read
      questions:
      - What fields are allowed in a creative rules document?
      - Is there a JSON Schema describing creative rules?
      instructions:
      - text: Get the JSON Schema for the rules of creative {id}.
        slots:
          id: path.id
      - text: Show the allowed structure of a creative rules document.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creatives/{id}/rules/context'].get
  update:
    x-apievangelist-phrasing:
      intent: Get context used to evaluate creative rules
      effect: read
      questions:
      - What supporting data is used when a creative's rules are evaluated?
      - Can I see the evaluation context behind a creative's rules?
      instructions:
      - text: Get the rules evaluation context for creative {id}.
        slots:
          id: path.id
      - text: Show the supporting data used to check creative {id}'s rules.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creatives/{id}/rules/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the change history of creative rules
      effect: read
      questions:
      - Who changed a creative's rules and when?
      - Is there an audit trail of edits to creative rules?
      instructions:
      - text: Show the rules change history for creative {id}.
        slots:
          id: path.id
      - text: List past edits to creative {id}'s rules.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'