Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mobile Game API

2 actions 2 updates phrasing extends openapi/punchh-game-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 2

$.info
$.paths['/api2/mobile/par_games'].get

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 Game API
  version: 1.0.0
extends: openapi/punchh-game-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: 1
- target: $.paths['/api2/mobile/par_games'].get
  update:
    x-apievangelist-phrasing:
      intent: List active game URLs for the app
      effect: read
      questions:
      - Which games has the brand set up for guests to play in the app?
      - Are inactive game URLs returned to the app?
      instructions:
      - text: List the active games for channel {channel}.
        slots:
          channel: requestBody.channel
      - text: Show page {page} of configured game links.
        slots:
          page: requestBody.page
      method: generated
      generated: '2026-10-01'