Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mobile Collectibles API

4 actions 4 updates phrasing extends openapi/punchh-collectibles-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/collectibles'].get
$.paths['/api2/mobile/collectibles/{collectible_id}'].get
$.paths['/api2/mobile/users_collectibles'].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 Collectibles API
  version: 1.0.0
extends: openapi/punchh-collectibles-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/collectibles'].get
  update:
    x-apievangelist-phrasing:
      intent: List the business's digital collectibles
      effect: read
      questions:
      - What digital collectibles can guests earn from this brand?
      - Can I filter the collectibles catalog by category?
      instructions:
      - text: List all collectibles in categories {collectible_category_id}.
        slots:
          collectible_category_id: requestBody.collectible_category_id
      - text: Show page {page} of the brand's collectibles catalog.
        slots:
          page: requestBody.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/collectibles/{collectible_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one collectible
      effect: read
      questions:
      - Which active campaigns award a particular collectible?
      - Can I fetch more than one collectible per request?
      instructions:
      - text: Show details for collectible {collectible_id}.
        slots:
          collectible_id: path.collectible_id
      - text: Which campaigns give out collectible {collectible_id}? Look it up.
        slots:
          collectible_id: path.collectible_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/users_collectibles'].get
  update:
    x-apievangelist-phrasing:
      intent: List collectibles a guest has earned
      effect: read
      questions:
      - Which collectibles has this guest earned so far?
      - Can I include collectibles that have disappeared from a guest's collection?
      instructions:
      - text: Show the collectibles I've earned.
      - text: 'List the guest''s earned collectibles including disappeared ones: {include_disappeared_collectibles}.'
        slots:
          include_disappeared_collectibles: requestBody.include_disappeared_collectibles
      method: generated
      generated: '2026-10-01'