Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mobile Offers API

3 actions 3 updates phrasing extends openapi/punchh-offers-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/offers'].get
$.paths['/api2/mobile/offers/mark_read'].put

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 Mobile Offers API
  version: 1.0.0
extends: openapi/punchh-offers-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/offers'].get
  update:
    x-apievangelist-phrasing:
      intent: List a guest's offers in the app
      effect: read
      questions:
      - Which offers does a guest currently have in the app?
      - Where does the News & Offers screen get its list of offers?
      instructions:
      - text: List my current offers.
      - text: Show the offers for app client {client}.
        slots:
          client: requestBody.client
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/offers/mark_read'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark offers as read
      effect: write
      questions:
      - Can I record that a guest opened an offer from a push notification?
      - How do I mark offers read after a guest views them in the app?
      instructions:
      - text: Mark rewards {rewards} as read via {event_type}.
        slots:
          rewards: requestBody.rewards
          event_type: requestBody.event_type
      - text: Mark notifications {notifications} as read through the app.
        slots:
          notifications: requestBody.user_notifications
      method: generated
      generated: '2026-10-01'