Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Rules / Sub-resource API

6 actions 6 updates phrasing extends openapi/live-direct-marketing-online-rules-sub-resource-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-sub'].get
$.paths['/api/creatives/{id}/rules/{sub}'].get
$.paths['/api/creatives/{id}/rules/{sub}'].patch
$.paths['/api/creatives/{id}/rules/{sub}/schema'].get
$.paths['/api/creatives/{id}/rules/{sub}/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 / Sub-resource API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-rules-sub-resource-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-sub'].get
  update:
    x-apievangelist-phrasing:
      intent: List a creative's autopilot rule sections
      effect: read
      questions:
      - Which autopilot rule sub-resources can I configure on a creative?
      - What sub-resource keys exist for creative autopilot rules?
      instructions:
      - text: List the available autopilot sub-resource keys for creative {id}.
        slots:
          id: path.id
      - text: Show which autopilot rule sections a creative has.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creatives/{id}/rules/{sub}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a creative's autopilot rules section
      effect: read
      questions:
      - What are the current autopilot rules in one section of a creative?
      - Can I read a single autopilot sub-resource rules document?
      instructions:
      - text: Get autopilot rules {sub} for creative {id}.
        slots:
          sub: path.sub
          id: path.id
      - text: Show the {sub} rules document on creative {id}.
        slots:
          sub: path.sub
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creatives/{id}/rules/{sub}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a creative's autopilot rules section
      effect: write
      questions:
      - Can I change just one section of a creative's autopilot rules?
      - Is it possible to partially update an autopilot rules document?
      instructions:
      - text: Patch the {sub} autopilot rules on creative {id}.
        slots:
          sub: path.sub
          id: path.id
      - text: Update creative {id}'s {sub} rules section.
        slots:
          id: path.id
          sub: path.sub
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creatives/{id}/rules/{sub}/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the JSON Schema for an autopilot rules section
      effect: read
      questions:
      - What shape must an autopilot rules section follow?
      - Can I fetch the JSON Schema that validates an autopilot sub-resource?
      instructions:
      - text: Get the JSON Schema for autopilot sub-resource {sub} on creative {id}.
        slots:
          sub: path.sub
          id: path.id
      - text: Show the validation schema of the {sub} rules section.
        slots:
          sub: path.sub
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creatives/{id}/rules/{sub}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history of an autopilot rules section
      effect: read
      questions:
      - Who changed a creative's autopilot rules, and when?
      - Can I see the audit trail for one autopilot rules section?
      instructions:
      - text: Show the last {limit} changes to {sub} rules on creative {id}.
        slots:
          limit: query.limit
          sub: path.sub
          id: path.id
      - text: Get the audit history of creative {id}'s {sub} rules.
        slots:
          id: path.id
          sub: path.sub
      method: generated
      generated: '2026-10-01'