Punchh · OpenAPI Overlay 1.0.0

API Evangelist enhancements for POS API

3 actions 3 updates documentation extends ./../openapi/punchh-pos-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

contactx-providerx-providerIdx-docsx-certification-requiredexternalDocsx-status-pagex-artifacts

Targets 3

$.info
$
$.servers[0]

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for POS API
  version: 1.0.0
extends: ./../openapi/punchh-pos-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: apis.yml + developers.partech.com developer portal
x-note: Captures the enhancements API Evangelist adds on top of the document PAR Punchh publishes. The underlying
  OpenAPI in openapi/ is never mutated.
actions:
- target: $.info
  update:
    contact:
      name: Punchh Dev Support
      url: https://developers.punchh.com
    x-provider: PAR Punchh
    x-providerId: punchh
    x-docs: https://developers.partech.com/docs/dev-portal-pos
    x-certification-required: true
- target: $
  update:
    externalDocs:
      description: PAR Punchh developer portal
      url: https://developers.partech.com/docs/dev-portal-pos
    x-status-page: https://status.punchh.com
    x-artifacts:
      authentication: authentication/punchh-authentication.yml
      conventions: conventions/punchh-conventions.yml
      errors: errors/punchh-problem-types.yml
      lifecycle: lifecycle/punchh-lifecycle.yml
      rate_limits: rate-limits/punchh-rate-limits.yml
      webhooks: asyncapi/punchh-webhooks.yml
      data_model: data-model/punchh-data-model.yml
- target: $.servers[0]
  update:
    description: Environment-specific Punchh host. The server_name value is issued per brand and per environment
      (sandbox / integration / production) by a Punchh representative and is not published.