Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Users API

3 actions 3 updates phrasing extends openapi/impact-users-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 3

$.info
$.paths['/Mediapartners/{AccountSID}/Users'].get
$.paths['/Mediapartners/{AccountSID}/Users/{Id}'].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 Partner Users API
  version: 1.0.0
extends: openapi/impact-users-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: 2
- target: $.paths['/Mediapartners/{AccountSID}/Users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users with access to a partner account
      effect: read
      questions:
      - Who has access to my partner account?
      - Can I filter account users by name or state?
      instructions:
      - text: List users on partner account {account}.
        slots:
          account: path.AccountSID
      - text: Find users named {name} with state {state} on account {account}.
        slots:
          account: path.AccountSID
          name: query.Name
          state: query.State
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Users/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a partner account user
      effect: read
      questions:
      - What details are stored for one person on my partner account?
      - Can I look up an account user by ID?
      instructions:
      - text: Get user {id} on partner account {account}.
        slots:
          account: path.AccountSID
          id: path.Id
      - text: Show account user {id} details for {account}.
        slots:
          account: path.AccountSID
          id: path.Id
      method: generated
      generated: '2026-09-26'