Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mobile Beacons API

3 actions 3 updates phrasing extends openapi/punchh-beacons-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/locations/beacon_entry'].post
$.paths['/api2/mobile/locations/beacon_exit'].delete

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 Beacons API
  version: 1.0.0
extends: openapi/punchh-beacons-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/locations/beacon_entry'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a guest entering a beacon's range
      effect: write
      questions:
      - What happens when a loyalty member walks into range of a store beacon?
      - Which beacon identifiers does the app send on entry?
      instructions:
      - text: Record a beacon entry for beacon {beacon_major}/{beacon_minor}.
        slots:
          beacon_major: requestBody.beacon_major
          beacon_minor: requestBody.beacon_minor
      - text: Log that the guest arrived near beacon minor {beacon_minor}.
        slots:
          beacon_minor: requestBody.beacon_minor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/locations/beacon_exit'].delete
  update:
    x-apievangelist-phrasing:
      intent: Record a guest leaving a beacon's range
      effect: destructive
      questions:
      - What gets triggered when a guest leaves a store beacon's range?
      - How does the app report that a detected guest walked away from a beacon?
      instructions:
      - text: Record a beacon exit for beacon {beacon_major}/{beacon_minor}.
        slots:
          beacon_major: requestBody.beacon_major
          beacon_minor: requestBody.beacon_minor
      - text: Log that the guest left the range of beacon minor {beacon_minor}.
        slots:
          beacon_minor: requestBody.beacon_minor
      method: generated
      generated: '2026-10-01'