Tapfiliate · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tapfiliate REST Payments API

5 actions 5 updates phrasing extends openapi/tapfiliate-payments-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 5

$.info

$.paths['/payments/{id}/'].get

$.paths['/payments/{id}/'].delete

$.paths['/payments/'].get

$.paths['/payments/'].post

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 Tapfiliate REST Payments API
  version: 1.0.0
extends: openapi/tapfiliate-payments-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: 4
- target: $.paths['/payments/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an affiliate payment
      effect: read
      questions:
      - Can I look up a single affiliate payment by its ID?
      - What details are stored on one payout payment?
      instructions:
      - text: Get payment {id}.
        slots:
          id: path.id
      - text: Show me the details of affiliate payment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payments/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending payment
      effect: destructive
      questions:
      - How do I cancel an affiliate payment that hasn't gone out yet?
      - Can I stop a pending payout before it's processed?
      instructions:
      - text: Cancel payment {id}.
        slots:
          id: path.id
      - text: Cancel the pending affiliate payment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payments/'].get
  update:
    x-apievangelist-phrasing:
      intent: List affiliate payments
      effect: read
      questions:
      - Which affiliate payments were paid out during a given period?
      - Can I filter the payment history to one affiliate?
      - Where can I see every payout we've made?
      instructions:
      - text: List all payments.
      - text: Show payments paid between {paid_at_from} and {paid_at_to}.
        slots:
          paid_at_from: query.paid_at_from
          paid_at_to: query.paid_at_to
      - text: List payments made to affiliate {affiliate_id}.
        slots:
          affiliate_id: query.affiliate_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payments/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an affiliate payment batch
      effect: write
      questions:
      - How do I pay out several affiliates in one batch?
      - Which currency does a new payment batch use?
      instructions:
      - text: Create a payment in {currency} for affiliates {affiliates}.
        slots:
          currency: requestBody.currency
          affiliates: requestBody.affiliates
      - text: Start a new payout batch in {currency} covering {affiliates}.
        slots:
          currency: requestBody.currency
          affiliates: requestBody.affiliates
      method: generated
      generated: '2026-10-01'