Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mobile Referrals API

3 actions 3 updates phrasing extends openapi/punchh-referrals-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 3

$.info

$.paths['/api2/mobile/{checkin_id}/referrals'].get

$.paths['/api2/mobile/{checkin_id}/referrals'].post

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 Mobile Referrals API
  version: 1.0.0
extends: openapi/punchh-referrals-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: 2
- target: $.paths['/api2/mobile/{checkin_id}/referrals'].get
  update:
    x-apievangelist-phrasing:
      intent: List who may have referred a guest
      effect: read
      questions:
      - Which members might have referred a new guest to the loyalty program?
      - Can I see possible referrers based on a guest's check-in?
      instructions:
      - text: List possible referrers for check-in {checkin_id}.
        slots:
          checkin_id: path.checkin_id
      - text: Show who could have referred me, based on check-in {checkin_id}.
        slots:
          checkin_id: path.checkin_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/{checkin_id}/referrals'].post
  update:
    x-apievangelist-phrasing:
      intent: Choose the member who referred a guest
      effect: write
      questions:
      - How does a guest credit the friend who referred them?
      - Can a guest pick their referrer after checking in?
      instructions:
      - text: Select {friend} as my referrer for check-in {checkin_id}.
        slots:
          friend: requestBody.friend_to_refer
          checkin_id: path.checkin_id
      - text: Credit friend {friend} with referring me on check-in {checkin_id}.
        slots:
          friend: requestBody.friend_to_refer
          checkin_id: path.checkin_id
      method: generated
      generated: '2026-10-01'