Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brand Notes API

6 actions 6 updates phrasing extends openapi/impact-notes-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 6

$.info

$.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes'].get

$.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes'].post

$.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes/{NoteId}'].get

$.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes/{NoteId}'].put

$.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes/{NoteId}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Brand Notes API
  version: 1.0.0
extends: openapi/impact-notes-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: 5
- target: $.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes on a campaign
      effect: read
      questions:
      - What notes have we logged about partners on this campaign?
      - Can I see notes for one partner within a date range?
      instructions:
      - text: List notes for campaign {campaign} in account {sid}.
        slots:
          sid: path.AccountSID
          campaign: path.CampaignId
      - text: Show campaign {campaign} notes about partner {media}.
        slots:
          campaign: path.CampaignId
          media: query.MediaId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note about a partner
      effect: write
      questions:
      - How do I record a note about a partner?
      - Can a partner note carry an attachment instead of text?
      instructions:
      - text: 'Add a note to partner {media} on campaign {campaign} in {sid}: {content}.'
        slots:
          sid: path.AccountSID
          campaign: path.CampaignId
          media: requestBody.MediaId
          content: requestBody.Content
      - text: Log a {type} note for partner {media} in campaign {campaign}.
        slots:
          type: requestBody.Type
          media: requestBody.MediaId
          campaign: path.CampaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes/{NoteId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a note's details
      effect: read
      questions:
      - What does a specific partner note say?
      - Can I look up a single note by its ID?
      instructions:
      - text: Get note {note} on campaign {campaign} in account {sid}.
        slots:
          sid: path.AccountSID
          campaign: path.CampaignId
          note: path.NoteId
      - text: Show me note {note} from campaign {campaign}.
        slots:
          campaign: path.CampaignId
          note: path.NoteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes/{NoteId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a note
      effect: write
      questions:
      - Can I change the text of a note I already wrote?
      - How do I add or remove attachments on an existing note?
      instructions:
      - text: Change note {note} on campaign {campaign} in {sid} to read {content}.
        slots:
          sid: path.AccountSID
          campaign: path.CampaignId
          note: path.NoteId
          content: requestBody.Content
      - text: Remove attachment {att} from note {note} in campaign {campaign}.
        slots:
          campaign: path.CampaignId
          note: path.NoteId
          att: requestBody.AttachmentsRemove
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Notes/{NoteId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a note
      effect: destructive
      questions:
      - Can I permanently remove a partner note?
      - Is there an undo after deleting a note?
      instructions:
      - text: Delete note {note} from campaign {campaign} in account {sid}.
        slots:
          sid: path.AccountSID
          campaign: path.CampaignId
          note: path.NoteId
      - text: Permanently erase note {note} in campaign {campaign}.
        slots:
          campaign: path.CampaignId
          note: path.NoteId
      method: generated
      generated: '2026-09-26'