Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mobile Badges API

2 actions 2 updates phrasing extends openapi/punchh-badges-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/badges/{badge_id}'].put

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 Badges API
  version: 1.0.0
extends: openapi/punchh-badges-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/badges/{badge_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Link a badge to a Facebook story
      effect: write
      questions:
      - How do I attach the Facebook post a guest shared to the badge they earned?
      - Can a badge be updated with a story ID?
      instructions:
      - text: Update badge {badge_id} with Facebook story {story_id}.
        slots:
          badge_id: path.badge_id
          story_id: requestBody.story_id
      - text: Link badge {badge_id} to the shared post.
        slots:
          badge_id: path.badge_id
      method: generated
      generated: '2026-10-01'