Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Configuration Break Types API

3 actions 3 updates phrasing extends openapi/toast-break-types-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 3

$.info

$.paths['/breakTypes/{guid}'].get

$.paths['/breakTypes'].get

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 Configuration Break Types API
  version: 1.0.0
extends: openapi/toast-break-types-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: 2
- target: $.paths['/breakTypes/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one break type
      effect: read
      questions:
      - How do I see the settings for one specific break type at a restaurant?
      - What details are stored for a single employee break type?
      instructions:
      - text: Get break type {guid} for restaurant {restaurant}.
        slots:
          guid: path.guid
          restaurant: header.Toast-Restaurant-External-ID
      - text: Show me the settings of break type {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/breakTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a restaurant's break types
      effect: read
      questions:
      - Which employee break types are configured at my restaurant?
      - Can I fetch only break types that changed after a given date?
      instructions:
      - text: List the break types configured at restaurant {restaurant}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      - text: List break types for {restaurant} modified since {since}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
          since: query.lastModified
      method: generated
      generated: '2026-10-01'