Tapfiliate · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tapfiliate REST Clicks API

4 actions 4 updates phrasing extends openapi/tapfiliate-clicks-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['/clicks/'].get
$.paths['/clicks/'].post
$.paths['/clicks/{id}/'].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 Clicks API
  version: 1.0.0
extends: openapi/tapfiliate-clicks-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['/clicks/'].get
  update:
    x-apievangelist-phrasing:
      intent: List affiliate clicks
      effect: read
      questions:
      - Which referral clicks came in during a given date range?
      - Can I see only the clicks driven by one affiliate?
      - How many clicks has my affiliate program received?
      instructions:
      - text: List clicks from {date_from} to {date_to}.
        slots:
          date_from: query.date_from
          date_to: query.date_to
      - text: Show all clicks for affiliate {affiliate_id}.
        slots:
          affiliate_id: query.affiliate_id
      - text: List the latest clicks.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clicks/'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a referral click
      effect: write
      questions:
      - How do I track a click on an affiliate's referral link from my server?
      - Can I record the visitor's IP, user agent and landing page with a click?
      instructions:
      - text: Record a click for referral code {referral_code}.
        slots:
          referral_code: requestBody.referral_code
      - text: Log a click for {referral_code} landing on {landing_page} from {referrer}.
        slots:
          referral_code: requestBody.referral_code
          landing_page: requestBody.landing_page
          referrer: requestBody.referrer
      - text: Track a click for referral code {referral_code} from IP {ip} with user agent {user_agent}.
        slots:
          referral_code: requestBody.referral_code
          ip: requestBody.ip
          user_agent: requestBody.user_agent
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clicks/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a click
      effect: read
      questions:
      - What details are recorded for a single click?
      - Can I look up one click by its ID?
      instructions:
      - text: Get click {id}.
        slots:
          id: path.id
      - text: Show me the detailed information for click {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'