Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Policy Service Marketing actions API

7 actions 7 updates phrasing extends openapi/adobe-suite-marketing-actions-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/marketingActions/core'].get
$.paths['/marketingActions/core/{MARKETING_ACTION_NAME}'].get
$.paths['/marketingActions/custom'].get
$.paths['/marketingActions/custom/{MARKETING_ACTION_NAME}'].get
$.paths['/marketingActions/custom/{MARKETING_ACTION_NAME}'].put
$.paths['/marketingActions/custom/{MARKETING_ACTION_NAME}'].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 Policy Service Marketing actions API
  version: 1.0.0
extends: openapi/adobe-suite-marketing-actions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/marketingActions/core'].get
  update:
    x-apievangelist-phrasing:
      intent: List Adobe-defined core marketing actions
      effect: read
      questions:
      - What core marketing actions does Adobe define for data governance?
      - Can I page through the built-in marketing actions?
      instructions:
      - text: List the core marketing actions.
      - text: Show the first {limit} core marketing actions sorted by {orderby}.
        slots:
          limit: query.limit
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketingActions/core/{MARKETING_ACTION_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a core marketing action
      effect: read
      questions:
      - How do I look up one of Adobe's core marketing actions by name?
      - What does a built-in marketing action like email targeting mean?
      instructions:
      - text: Show core marketing action {action}.
        slots:
          action: path.MARKETING_ACTION_NAME
      - text: Get the description of core marketing action {action}.
        slots:
          action: path.MARKETING_ACTION_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketingActions/custom'].get
  update:
    x-apievangelist-phrasing:
      intent: List my organization's custom marketing actions
      effect: read
      questions:
      - Which custom marketing actions has my organization defined?
      - Can I sort or limit my custom marketing actions list?
      instructions:
      - text: List our custom marketing actions.
      - text: Show {limit} custom marketing actions ordered by {orderby}.
        slots:
          limit: query.limit
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketingActions/custom/{MARKETING_ACTION_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom marketing action
      effect: read
      questions:
      - How do I look up a custom marketing action my team created?
      - What's the description of one of our custom marketing actions?
      instructions:
      - text: Show custom marketing action {action}.
        slots:
          action: path.MARKETING_ACTION_NAME
      - text: Get the details of our custom marketing action {action}.
        slots:
          action: path.MARKETING_ACTION_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketingActions/custom/{MARKETING_ACTION_NAME}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a custom marketing action
      effect: write
      questions:
      - How do I define a new custom marketing action for data usage policies?
      - If a custom marketing action already exists with that name, will it be updated?
      instructions:
      - text: Create custom marketing action {action} named {name}.
        slots:
          action: path.MARKETING_ACTION_NAME
          name: requestBody.name
      - text: Set the description of custom marketing action {action} named {name} to {description}.
        slots:
          action: path.MARKETING_ACTION_NAME
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketingActions/custom/{MARKETING_ACTION_NAME}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom marketing action
      effect: destructive
      questions:
      - How do I remove a custom marketing action we no longer use?
      - Can I delete a custom marketing action through the API?
      instructions:
      - text: Delete custom marketing action {action}.
        slots:
          action: path.MARKETING_ACTION_NAME
      - text: Remove our marketing action {action}.
        slots:
          action: path.MARKETING_ACTION_NAME
      method: generated
      generated: '2026-09-26'