Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mobile Passcodes API

3 actions 3 updates phrasing extends openapi/punchh-passcodes-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/passcodes/forgot_passcode'].post
$.paths['/api2/mobile/passcodes'].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 Mobile Passcodes API
  version: 1.0.0
extends: openapi/punchh-passcodes-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/passcodes/forgot_passcode'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a guest a passcode reset link
      effect: write
      questions:
      - What happens when a guest taps reset passcode in the app?
      - How does a guest recover a forgotten app passcode?
      instructions:
      - text: Send me a passcode reset email.
      - text: Email the guest a reset passcode link for client {client}.
        slots:
          client: requestBody.client
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/passcodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a secondary passcode for a guest
      effect: write
      questions:
      - How does a guest set up a PIN to protect gift cards and payments in the app?
      - Can I create a passcode for the signed-in user?
      instructions:
      - text: Set my passcode to {passcode}.
        slots:
          passcode: requestBody.passcode
      - text: Create passcode {passcode} for the guest.
        slots:
          passcode: requestBody.passcode
      method: generated
      generated: '2026-10-01'