Awin · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Awin Programmes API

3 actions 3 updates phrasing extends openapi/awin-affiliate-programmes-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Awin's API. It is a proposal applied on top of the contract, not a document Awin publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/publishers/{publisherId}/programmes'].get
$.paths['/publishers/{publisherId}/programmedetails'].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 Awin Programmes API
  version: 1.0.0
extends: openapi/awin-affiliate-programmes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/publishers/{publisherId}/programmes'].get
  update:
    x-apievangelist-phrasing:
      intent: List the advertiser programmes a publisher works with
      effect: read
      questions:
      - Which advertiser programmes have I joined as an Awin publisher?
      - Can I list only the programmes available in one country?
      - What programmes am I still pending approval on or have not joined yet?
      instructions:
      - text: List the advertiser programmes publisher {publisherId} has joined.
        slots:
          publisherId: path.publisherId
      - text: List programmes for publisher {publisherId} with relationship {relationship} in country {countryCode}.
        slots:
          publisherId: path.publisherId
          relationship: query.relationship
          countryCode: query.countryCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/publishers/{publisherId}/programmedetails'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one advertiser programme
      effect: read
      questions:
      - What are the valid domains, KPIs and commission range for one advertiser's programme?
      - How do I check my membership status in a specific advertiser's programme?
      - Where can I read the description of a single programme before promoting it?
      instructions:
      - text: Show programme details for advertiser {advertiserId} as seen by publisher {publisherId}.
        slots:
          advertiserId: query.advertiserId
          publisherId: path.publisherId
      - text: Get the commission range and KPIs of advertiser {advertiserId}'s programme for publisher {publisherId} where the relationship is {relationship}.
        slots:
          advertiserId: query.advertiserId
          publisherId: path.publisherId
          relationship: query.relationship
      method: generated
      generated: '2026-10-01'