Thanx · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thanx Consumer Purchases API

3 actions 3 updates phrasing extends openapi/thanx-purchases-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Thanx's API. It is a proposal applied on top of the contract, not a document Thanx publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/purchases'].get
$.paths['/purchases'].post

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 Thanx Consumer Purchases API
  version: 1.0.0
extends: openapi/thanx-purchases-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/purchases'].get
  update:
    x-apievangelist-phrasing:
      intent: List consumer purchases
      effect: read
      questions:
      - What purchases has a particular customer made?
      - Can I filter purchases by location or merchant?
      - How do I page through recorded purchases in Thanx?
      instructions:
      - text: List purchases by user {user_id}.
        slots:
          user_id: query.user_id
      - text: Show purchases at location {location_id} for merchant {merchant_id}.
        slots:
          location_id: query.location_id
          merchant_id: query.merchant_id
      - text: Get page {page} of purchases, {per_page} per page.
        slots:
          page: query.page
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/purchases'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a consumer purchase
      effect: write
      questions:
      - How do I report a customer's purchase so it counts toward loyalty?
      - Can I send a new purchase record from my point of sale?
      instructions:
      - text: Report purchase {purchase}.
        slots:
          purchase: requestBody.purchase
      - text: 'Record a new consumer purchase with these details: {purchase}.'
        slots:
          purchase: requestBody.purchase
      method: generated
      generated: '2026-09-26'