Tapfiliate · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tapfiliate REST Affiliate Groups API

4 actions 4 updates phrasing extends openapi/tapfiliate-affiliate-groups-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 4

$.info
$.paths['/affiliate-groups/'].get
$.paths['/affiliate-groups/'].post
$.paths['/affiliate-groups/{affiliate_group_id}/'].patch

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 Affiliate Groups API
  version: 1.0.0
extends: openapi/tapfiliate-affiliate-groups-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: 3
- target: $.paths['/affiliate-groups/'].get
  update:
    x-apievangelist-phrasing:
      intent: List affiliate groups
      effect: read
      questions:
      - Which affiliate groups have I set up in Tapfiliate?
      - Can I page through my affiliate groups a few at a time?
      instructions:
      - text: Show me all my affiliate groups.
      - text: List affiliate groups, {limit} per page, page {page}.
        slots:
          limit: query.limit
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/affiliate-groups/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an affiliate group
      effect: write
      questions:
      - How do I create a new group to organize my affiliates?
      - Is a name all I need to set up a new affiliate group?
      instructions:
      - text: Create an affiliate group called {name}.
        slots:
          name: requestBody.name
      - text: Add a new affiliate group named {name} for our top partners.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/affiliate-groups/{affiliate_group_id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename an affiliate group
      effect: write
      questions:
      - Can I rename an affiliate group that already exists?
      - What can I change on an existing affiliate group?
      instructions:
      - text: Rename affiliate group {affiliate_group_id} to {name}.
        slots:
          affiliate_group_id: path.affiliate_group_id
          name: requestBody.name
      - text: Update the name of existing affiliate group {affiliate_group_id}.
        slots:
          affiliate_group_id: path.affiliate_group_id
      method: generated
      generated: '2026-10-01'