Tapfiliate · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tapfiliate REST Balances API

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

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/balances/'].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 Tapfiliate REST Balances API
  version: 1.0.0
extends: openapi/tapfiliate-balances-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: 1
- target: $.paths['/balances/'].get
  update:
    x-apievangelist-phrasing:
      intent: List all affiliate balances
      effect: read
      questions:
      - How much do I owe all my affiliates across every program?
      - Can I see every affiliate's outstanding balance in one list?
      instructions:
      - text: List balances for all affiliates.
      - text: Show page {page} of affiliate balances, {limit} at a time.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'