Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mobile File Upload API

2 actions 2 updates phrasing extends openapi/punchh-file-upload-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/file_upload'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mobile File Upload API
  version: 1.0.0
extends: openapi/punchh-file-upload-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/file_upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a signed URL to upload a file
      effect: write
      questions:
      - How does the app get a signed URL to upload a photo?
      - Do I need to name the file when requesting an upload URL?
      instructions:
      - text: Get a signed upload URL for file {file_name}.
        slots:
          file_name: requestBody.file_name
      - text: Give me somewhere to upload {file_name}.
        slots:
          file_name: requestBody.file_name
      method: generated
      generated: '2026-10-01'