Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Company Information Accounts API

3 actions 3 updates phrasing extends openapi/impact-accounts-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}/CompanyInformation'].get

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

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 Company Information Accounts API
  version: 1.0.0
extends: openapi/impact-accounts-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}/CompanyInformation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a partner's company profile
      effect: read
      questions:
      - What profile details are on my partner account?
      - Where can I see my partner account metadata?
      instructions:
      - text: Retrieve company information for partner account {sid}.
        slots:
          sid: path.AccountSID
      - text: Show the profile and contacts on partner account {sid}.
        slots:
          sid: path.AccountSID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/CompanyInformation'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a partner's company profile
      effect: write
      questions:
      - How do I update my partner profile description and logo?
      - Can I change my content interests or promotional methods?
      instructions:
      - text: Update partner account {sid} with description {desc}, content interests {interests}, logo {logo}.
        slots:
          sid: path.AccountSID
          desc: requestBody.Description
          interests: requestBody.ContentInterests
          logo: requestBody.LogoImage
      - text: Set my partner website to {site} with interests {interests}, description {desc}, logo {logo}.
        slots:
          site: requestBody.Website
          interests: requestBody.ContentInterests
          desc: requestBody.Description
          logo: requestBody.LogoImage
      method: generated
      generated: '2026-09-26'