Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brand API - Exception Lists Exception List Items API

7 actions 7 updates phrasing extends openapi/impact-exception-list-items-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Impact's API. It is a proposal applied on top of the contract, not a document Impact publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items'].get
$.paths['/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items'].post
$.paths['/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items'].delete
$.paths['/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items'].patch
$.paths['/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items/{ItemId}'].get
$.paths['/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items/{ItemId}'].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 Brand API - Exception Lists Exception List Items API
  version: 1.0.0
extends: openapi/impact-exception-list-items-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['/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items'].get
  update:
    x-apievangelist-phrasing:
      intent: List items in an exception list
      effect: read
      questions:
      - Which values are on one of my exception lists?
      - Can I check whether a specific value is already in an exception list?
      instructions:
      - text: List the items in exception list {list} for account {account}.
        slots:
          account: path.AccountSID
          list: path.ExceptionListId
      - text: Find value {value} in exception list {list}, account {account}.
        slots:
          account: path.AccountSID
          list: path.ExceptionListId
          value: query.Value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add items to an exception list
      effect: write
      questions:
      - Can I add one value, or upload a file of many, to an exception list?
      - Is there an upsert option when adding exception list items?
      instructions:
      - text: Add value {value} named {name} to exception list {list} in account {account}.
        slots:
          account: path.AccountSID
          list: path.ExceptionListId
          value: requestBody.Value
          name: requestBody.Name
      - text: Upload file {file} of new items to exception list {list}, account {account}.
        slots:
          account: path.AccountSID
          list: path.ExceptionListId
          file: requestBody.File
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all items from an exception list
      effect: destructive
      questions:
      - Can I empty an exception list in one call?
      - Is clearing every item from an exception list undoable?
      instructions:
      - text: Clear every item out of exception list {list} in account {account}.
        slots:
          account: path.AccountSID
          list: path.ExceptionListId
      - text: Empty exception list {list} for account {account}.
        slots:
          account: path.AccountSID
          list: path.ExceptionListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items'].patch
  update:
    x-apievangelist-phrasing:
      intent: Replace all items in an exception list from a file
      effect: write
      questions:
      - Can I swap an exception list's entire contents with a new CSV or XLSX file?
      - Which file formats are accepted when replacing an exception list's items?
      instructions:
      - text: Replace everything in exception list {list} with file {file} in account {account}.
        slots:
          account: path.AccountSID
          list: path.ExceptionListId
          file: requestBody.File
      - text: Overwrite exception list {list} in account {account} using spreadsheet {file}.
        slots:
          account: path.AccountSID
          list: path.ExceptionListId
          file: requestBody.File
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items/{ItemId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one exception list item
      effect: read
      questions:
      - What are the details of a single entry in an exception list?
      - Can I fetch one exception list item by its ID?
      instructions:
      - text: Get item {item} from exception list {list} in account {account}.
        slots:
          account: path.AccountSID
          list: path.ExceptionListId
          item: path.ItemId
      - text: Show exception list entry {item} on list {list}, account {account}.
        slots:
          account: path.AccountSID
          list: path.ExceptionListId
          item: path.ItemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items/{ItemId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one item from an exception list
      effect: destructive
      questions:
      - Can I remove just one value from an exception list without touching the rest?
      - Is removing a single exception list entry permanent?
      instructions:
      - text: Delete item {item} from exception list {list} in account {account}.
        slots:
          account: path.AccountSID
          list: path.ExceptionListId
          item: path.ItemId
      - text: Remove only entry {item} from exception list {list}, account {account}.
        slots:
          account: path.AccountSID
          list: path.ExceptionListId
          item: path.ItemId
      method: generated
      generated: '2026-09-26'