Tapfiliate · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tapfiliate REST Commissions API

6 actions 6 updates phrasing extends openapi/tapfiliate-commissions-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 6

$.info

$.paths['/commissions/{commission_id}/'].get

$.paths['/commissions/{commission_id}/'].patch

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

$.paths['/commissions/{commission_id}/approved/'].put

$.paths['/commissions/{commission_id}/approved/'].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 Tapfiliate REST Commissions API
  version: 1.0.0
extends: openapi/tapfiliate-commissions-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: 5
- target: $.paths['/commissions/{commission_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a commission
      effect: read
      questions:
      - Can I look up one commission by its ID?
      - What details does a single commission record show?
      instructions:
      - text: Get commission {commission_id}.
        slots:
          commission_id: path.commission_id
      - text: Show me the details of commission {commission_id}.
        slots:
          commission_id: path.commission_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/commissions/{commission_id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a commission amount
      effect: write
      questions:
      - Can I adjust the amount of a commission after it was created?
      - How do I correct a commission amount that was calculated wrong?
      instructions:
      - text: Set the amount of commission {commission_id} to {amount}.
        slots:
          commission_id: path.commission_id
          amount: requestBody.amount
      - text: Update commission {commission_id}.
        slots:
          commission_id: path.commission_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/commissions/'].get
  update:
    x-apievangelist-phrasing:
      intent: List commissions
      effect: read
      questions:
      - Which commissions are still waiting for approval?
      - Can I list the commissions earned by one affiliate?
      - Where do I see all commissions in my program?
      instructions:
      - text: List all commissions.
      - text: Show commissions for affiliate {affiliate_id}.
        slots:
          affiliate_id: query.affiliate_id
      - text: List commissions filtered by approval status {approved}.
        slots:
          approved: query.approved
      method: generated
      generated: '2026-10-01'
- target: $.paths['/commissions/{commission_id}/approved/'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve a commission
      effect: write
      questions:
      - How do I approve a pending commission so it can be paid out?
      - Can I sign off on a single commission an affiliate earned?
      instructions:
      - text: Approve commission {commission_id}.
        slots:
          commission_id: path.commission_id
      - text: Mark pending commission {commission_id} as approved.
        slots:
          commission_id: path.commission_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/commissions/{commission_id}/approved/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disapprove a commission
      effect: destructive
      questions:
      - Can I revoke approval on a commission I already approved?
      - What happens if I disapprove an approved commission?
      instructions:
      - text: Disapprove commission {commission_id}.
        slots:
          commission_id: path.commission_id
      - text: Withdraw the approval on commission {commission_id}.
        slots:
          commission_id: path.commission_id
      method: generated
      generated: '2026-10-01'