Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Impact Programs API

6 actions 6 updates phrasing extends openapi/impact-programs-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'].get

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

$.paths['/Mediapartners/{AccountSID}/Campaigns'].get

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

$.paths['/Mediapartners/{AccountSID}/Campaigns/{CampaignId}/Logo'].get

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 Impact Programs API
  version: 1.0.0
extends: openapi/impact-programs-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List a brand's programs
      effect: read
      questions:
      - Which programs does my brand account run?
      - Can a brand filter its programs by name or state?
      instructions:
      - text: As brand account {account}, list all programs.
        slots:
          account: path.AccountSID
      - text: Find brand programs named {name} with state {state} in account {account}.
        slots:
          account: path.AccountSID
          name: query.Name
          state: query.State
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand program's details
      effect: read
      questions:
      - What settings does one of my brand's programs have?
      - Can a brand fetch a single program by ID?
      instructions:
      - text: As brand account {account}, get program {campaign}.
        slots:
          account: path.AccountSID
          campaign: path.CampaignId
      - text: Show brand program {campaign} details in account {account}.
        slots:
          account: path.AccountSID
          campaign: path.CampaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List programs a partner has joined
      effect: read
      questions:
      - Which brand programs have I signed up for as a partner?
      - Can a partner filter joined programs by insertion order status?
      instructions:
      - text: As partner account {account}, list the programs I've joined.
        slots:
          account: path.AccountSID
      - text: Show joined programs in partner account {account} with insertion order status {status}.
        slots:
          account: path.AccountSID
          status: query.InsertionOrderStatus
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Campaigns/{CampaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a program a partner joined
      effect: read
      questions:
      - As a partner, what are the details of a program I joined?
      - Can a partner look up one joined program by its ID?
      instructions:
      - text: As partner account {account}, retrieve joined program {campaign}.
        slots:
          account: path.AccountSID
          campaign: path.CampaignId
      - text: Get the partner-side details of program {campaign} in account {account}.
        slots:
          account: path.AccountSID
          campaign: path.CampaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Campaigns/{CampaignId}/Logo'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a program's logo image
      effect: read
      questions:
      - Can I get a brand program's logo to show on my site?
      - Which image formats can a program logo be returned in?
      instructions:
      - text: Download the logo for program {campaign} in partner account {account}.
        slots:
          account: path.AccountSID
          campaign: path.CampaignId
      - text: Fetch program {campaign}'s logo as an image for account {account}.
        slots:
          account: path.AccountSID
          campaign: path.CampaignId
      method: generated
      generated: '2026-09-26'