Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Online Ordering and SSO Rewards API

6 actions 6 updates phrasing extends openapi/punchh-rewards-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Punchh's API. It is a proposal applied on top of the contract, not a document Punchh publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/api/auth/loyalty_points_estimator'].get

$.paths['/api/auth/conversions'].post

$.paths['/api/auth/estimate_points'].get

$.paths['/api/auth/ordering_meta'].get

$.paths['/api/auth/offers'].get

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 Online Ordering and SSO Rewards API
  version: 1.0.0
extends: openapi/punchh-rewards-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: 5
- target: $.paths['/api/auth/loyalty_points_estimator'].get
  update:
    x-apievangelist-phrasing:
      intent: Estimate points from an order subtotal
      effect: read
      questions:
      - How many points would a guest earn on a $25 subtotal before they check out?
      - Does the loyalty points estimator include special promotions?
      instructions:
      - text: Estimate loyalty points for a subtotal of {subtotal_amount}.
        slots:
          subtotal_amount: requestBody.subtotal_amount
      - text: Using the loyalty points estimator, predict what a {subtotal_amount} order earns.
        slots:
          subtotal_amount: requestBody.subtotal_amount
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/conversions'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert points to cash, fuel or charity
      effect: write
      questions:
      - Can a guest turn loyalty points into cash credit or a fuel discount?
      - How do I donate points to a charity campaign?
      instructions:
      - text: Convert {source_value} points to {converted_value} using rule {conversion_rule_id}.
        slots:
          source_value: requestBody.source_value
          converted_value: requestBody.converted_value
          conversion_rule_id: requestBody.conversion_rule_id
      - text: Donate {source_value} points as {converted_value} to cause {social_cause_campaign_id} under rule {conversion_rule_id}.
        slots:
          source_value: requestBody.source_value
          converted_value: requestBody.converted_value
          social_cause_campaign_id: requestBody.social_cause_campaign_id
          conversion_rule_id: requestBody.conversion_rule_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/estimate_points'].get
  update:
    x-apievangelist-phrasing:
      intent: Estimate points for a cart with menu items
      effect: read
      questions:
      - What would the items in this cart earn in points before the order is placed?
      - Can I pass menu items to get an itemized points estimate?
      instructions:
      - text: Estimate points for menu items {menu_items} with subtotal {subtotal_amount} and receipt {receipt_amount}.
        slots:
          menu_items: requestBody.menu_items
          subtotal_amount: requestBody.subtotal_amount
          receipt_amount: requestBody.receipt_amount
      - text: 'Predict the points for this cart: receipt {receipt_amount}, subtotal {subtotal_amount}.'
        slots:
          receipt_amount: requestBody.receipt_amount
          subtotal_amount: requestBody.subtotal_amount
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/ordering_meta'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the base redeemable for ordering
      effect: read
      questions:
      - What is the base redeemable configured for online ordering?
      - Which filter value returns base redeemable metadata?
      instructions:
      - text: Get ordering meta with filter {filter}.
        slots:
          filter: query.filter
      - text: Show the base redeemable details using filter {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/offers'].get
  update:
    x-apievangelist-phrasing:
      intent: List offers available to a guest
      effect: read
      questions:
      - How many offers does this guest have available right now?
      - Can an ordering site show a guest their available offers?
      instructions:
      - text: Fetch the offers available to the guest.
      - text: List available offers for guest token {authentication_token}.
        slots:
          authentication_token: requestBody.authentication_token
      method: generated
      generated: '2026-10-01'