Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Impact Tasks API

5 actions 5 updates phrasing extends openapi/impact-tasks-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 5

$.info
$.paths['/Advertisers/{AccountSID}/Programs/{ProgramId}/Tasks'].get
$.paths['/Advertisers/{AccountSID}/Programs/{ProgramId}/Tasks/{TaskId}'].get
$.paths['/Mediapartners/{AccountSID}/Tasks'].get
$.paths['/Mediapartners/{AccountSID}/Tasks/{TaskId}'].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 Impact Tasks API
  version: 1.0.0
extends: openapi/impact-tasks-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: 4
- target: $.paths['/Advertisers/{AccountSID}/Programs/{ProgramId}/Tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a program's tasks as a brand
      effect: read
      questions:
      - What open tasks exist on my program?
      - Can a brand filter program tasks by type or last update?
      instructions:
      - text: List tasks on program {program} in brand account {sid}.
        slots:
          sid: path.AccountSID
          program: path.ProgramId
      - text: Show program {program} tasks of type {type}.
        slots:
          program: path.ProgramId
          type: query.Type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Programs/{ProgramId}/Tasks/{TaskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a program task as a brand
      effect: read
      questions:
      - What's in a specific task on my brand's program?
      - Can a brand look up a program task by ID?
      instructions:
      - text: Get task {task} on program {program} in account {sid}.
        slots:
          sid: path.AccountSID
          program: path.ProgramId
          task: path.TaskId
      - text: Show brand program {program} task {task}.
        slots:
          program: path.ProgramId
          task: path.TaskId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List tasks assigned to a partner
      effect: read
      questions:
      - What tasks have brands assigned to me as a partner?
      - Can I see partner tasks created after a certain date?
      instructions:
      - text: List tasks assigned to partner account {sid}.
        slots:
          sid: path.AccountSID
      - text: Show my partner tasks created after {after}.
        slots:
          after: query.DateCreatedAfter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Tasks/{TaskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task assigned to a partner
      effect: read
      questions:
      - What does a task assigned to my partner account ask me to do?
      - Where do I see details of one assigned task?
      instructions:
      - text: Get assigned task {task} on partner account {sid}.
        slots:
          sid: path.AccountSID
          task: path.TaskId
      - text: Show the partner task {task} I was given.
        slots:
          task: path.TaskId
      method: generated
      generated: '2026-09-26'