Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gift Card Integration Yourendpointname API

2 actions 2 updates phrasing extends openapi/toast-yourendpointname-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Toast's API. It is a proposal applied on top of the contract, not a document Toast publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/yourendpointname'].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 Gift Card Integration Yourendpointname API
  version: 1.0.0
extends: openapi/toast-yourendpointname-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['/yourendpointname'].post
  update:
    x-apievangelist-phrasing:
      intent: Receive gift card transaction information
      effect: write
      questions:
      - What gift card transaction details does the platform send to a gift card provider's endpoint?
      - Which gift card transaction types, like redeem or add value, can my endpoint receive?
      instructions:
      - text: Handle a gift card transaction of type {type}.
        slots:
          type: header.Toast-Transaction-Type
      - text: Process gift card redemption {redeem} for transaction {txn}.
        slots:
          redeem: requestBody.redeemTransactionInformation
          txn: header.Toast-Transaction-GUID
      method: generated
      generated: '2026-10-01'