Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Media Properties API

6 actions 6 updates phrasing extends openapi/impact-media-properties-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['/Mediapartners/{AccountSID}/MediaProperties'].get

$.paths['/Mediapartners/{AccountSID}/MediaProperties'].post

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

$.paths['/Mediapartners/{AccountSID}/MediaProperties/{Id}'].put

$.paths['/Mediapartners/{AccountSID}/MediaProperties/{Id}'].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 Partner Media Properties API
  version: 1.0.0
extends: openapi/impact-media-properties-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['/Mediapartners/{AccountSID}/MediaProperties'].get
  update:
    x-apievangelist-phrasing:
      intent: List a partner's media properties
      effect: read
      questions:
      - Which websites, apps and social accounts are registered as my media properties?
      - Can I see all media properties on my partner account?
      instructions:
      - text: List all media properties in partner account {account}.
        slots:
          account: path.AccountSID
      - text: Show the websites and apps registered on account {account}.
        slots:
          account: path.AccountSID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/MediaProperties'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new media property
      effect: write
      questions:
      - How do I add a new website or social channel as a media property?
      - Does a newly added media property need to be verified before approval?
      instructions:
      - text: Add media property {name} of type {type} at {url} to account {account}.
        slots:
          account: path.AccountSID
          name: requestBody.Name
          type: requestBody.Type
          url: requestBody.Url
      - text: Register social handle {handle} as a {type} property named {name} at {url} in account {account}.
        slots:
          account: path.AccountSID
          handle: requestBody.Handle
          type: requestBody.Type
          name: requestBody.Name
          url: requestBody.Url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/MediaProperties/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a media property
      effect: read
      questions:
      - What details are stored for one of my media properties?
      - Can I fetch a single media property by its ID?
      instructions:
      - text: Get media property {id} in account {account}.
        slots:
          account: path.AccountSID
          id: path.Id
      - text: Show the details of media property {id}, account {account}.
        slots:
          account: path.AccountSID
          id: path.Id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/MediaProperties/{Id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a media property
      effect: write
      questions:
      - Can I change the URL or follower count on an existing media property?
      - Are submitted media property values overwritten entirely?
      instructions:
      - text: Update media property {id} in account {account} with URL {url}.
        slots:
          account: path.AccountSID
          id: path.Id
          url: requestBody.Url
      - text: Set followers on media property {id} to {followers} in account {account}.
        slots:
          account: path.AccountSID
          id: path.Id
          followers: requestBody.Followers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/MediaProperties/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a media property
      effect: destructive
      questions:
      - Can I remove a website I no longer run from my media properties?
      - Is deleting a media property permanent?
      instructions:
      - text: Delete media property {id} from account {account}.
        slots:
          account: path.AccountSID
          id: path.Id
      - text: Permanently remove media property {id} in account {account}.
        slots:
          account: path.AccountSID
          id: path.Id
      method: generated
      generated: '2026-09-26'