Tapfiliate · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tapfiliate REST Affiliate Prospects API

5 actions 5 updates phrasing extends openapi/tapfiliate-affiliate-prospects-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['/affiliate-prospects/'].get

$.paths['/affiliate-prospects/'].post

$.paths['/affiliate-prospects/{affiliate_prospect_id}/'].get

$.paths['/affiliate-prospects/{affiliate_prospect_id}/'].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 Affiliate Prospects API
  version: 1.0.0
extends: openapi/tapfiliate-affiliate-prospects-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['/affiliate-prospects/'].get
  update:
    x-apievangelist-phrasing:
      intent: List affiliate prospects
      effect: read
      questions:
      - Who has applied to become an affiliate but isn't one yet?
      - Can I paginate through the list of affiliate prospects?
      instructions:
      - text: List all affiliate prospects.
      - text: Show page {page} of affiliate prospects with {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/affiliate-prospects/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an affiliate prospect
      effect: write
      questions:
      - How do I record someone as a prospective affiliate before they join?
      - What details are required to submit an affiliate prospect application?
      instructions:
      - text: Create an affiliate prospect for {firstname} {lastname} at {email}.
        slots:
          firstname: requestBody.firstname
          lastname: requestBody.lastname
          email: requestBody.email
      - text: Submit a prospect application for {email}, named {firstname} {lastname}, with metadata {meta_data}.
        slots:
          email: requestBody.email
          firstname: requestBody.firstname
          lastname: requestBody.lastname
          meta_data: requestBody.meta_data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/affiliate-prospects/{affiliate_prospect_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an affiliate prospect
      effect: read
      questions:
      - Can I see the details of one specific affiliate prospect?
      - What information is stored for a single prospect application?
      instructions:
      - text: Get affiliate prospect {affiliate_prospect_id}.
        slots:
          affiliate_prospect_id: path.affiliate_prospect_id
      - text: Show me the prospect application with ID {affiliate_prospect_id}.
        slots:
          affiliate_prospect_id: path.affiliate_prospect_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/affiliate-prospects/{affiliate_prospect_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an affiliate prospect
      effect: destructive
      questions:
      - Can I remove a prospect application I don't want to pursue?
      - How do I delete an affiliate prospect record?
      instructions:
      - text: Delete affiliate prospect {affiliate_prospect_id}.
        slots:
          affiliate_prospect_id: path.affiliate_prospect_id
      - text: Remove the prospect application {affiliate_prospect_id} from Tapfiliate.
        slots:
          affiliate_prospect_id: path.affiliate_prospect_id
      method: generated
      generated: '2026-10-01'