Thanx · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thanx Loyalty Baskets API

2 actions 2 updates phrasing extends openapi/thanx-baskets-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 2

$.info
$.paths['/api/baskets'].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 Loyalty Baskets API
  version: 1.0.0
extends: openapi/thanx-baskets-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: 1
- target: $.paths['/api/baskets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update an order basket with loyalty discounts
      effect: write
      questions:
      - How do I calculate loyalty discounts on an online order before checkout?
      - Can more than one reward be redeemed on the same order?
      - What does the basket need to include to apply a points product to an order?
      instructions:
      - text: Create a basket at location {location_uid} with subtotal {subtotal}, items {items}, state {state}, placed at {order_timestamp}.
        slots:
          location_uid: requestBody.location_uid
          subtotal: requestBody.subtotal
          items: requestBody.items
          state: requestBody.state
          order_timestamp: requestBody.order_timestamp
      - text: Update basket {id} to state {state} and apply reward {rewards}.
        slots:
          id: requestBody.id
          state: requestBody.state
          rewards: requestBody.rewards
      - text: Redeem points product {points_products} on basket {id}.
        slots:
          points_products: requestBody.points_products
          id: requestBody.id
      method: generated
      generated: '2026-09-26'