Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mobile Meta & Version API

4 actions 4 updates phrasing extends openapi/punchh-meta-version-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 4

$.info
$.paths['/api2/mobile/meta.json'].get
$.paths['/api2/mobile/version_notes'].get
$.paths['/api2/mobile/batch_api'].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 Meta & Version API
  version: 1.0.0
extends: openapi/punchh-meta-version-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: 3
- target: $.paths['/api2/mobile/meta.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get loyalty program details for the app
      effect: read
      questions:
      - How does the mobile app learn the program type, locations and redeemables for a business?
      - Can I leave locations out of the program meta response to keep it small?
      instructions:
      - text: Get the app's program meta.
      - text: 'Fetch program meta without locations: {exclude_locations}.'
        slots:
          exclude_locations: requestBody.exclude_locations
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/version_notes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get release notes for an app version
      effect: read
      questions:
      - What changed in a specific version of the brand's app?
      - Can I get version notes for Android versus iOS?
      instructions:
      - text: Show the version notes for app version {version} on {os}.
        slots:
          version: requestBody.version
          os: requestBody.os
      - text: Get release notes for version {version} on device model {model}.
        slots:
          version: requestBody.version
          model: requestBody.model
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/batch_api'].post
  update:
    x-apievangelist-phrasing:
      intent: Send several mobile API calls in one request
      effect: write
      questions:
      - Can the app bundle several API calls into a single HTTP request?
      - Can a batch response include the headers of each call?
      instructions:
      - text: 'Run these calls as one batch: {batch}.'
        slots:
          batch: requestBody.batch
      - text: 'Send batch {batch} and include each call''s headers: {show_headers_in_response}.'
        slots:
          batch: requestBody.batch
          show_headers_in_response: requestBody.show_headers_in_response
      method: generated
      generated: '2026-10-01'