Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Restaurant Service Availability API

2 actions 2 updates phrasing extends openapi/toast-availability-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['/availability'].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 Restaurant Service Availability API
  version: 1.0.0
extends: openapi/toast-availability-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['/availability'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a restaurant accepts online orders
      effect: read
      questions:
      - Is this restaurant currently online or offline for online ordering?
      - Can I still place orders when a restaurant shows as offline for online ordering?
      instructions:
      - text: Check whether restaurant {restaurant} is accepting online orders right now.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      - text: Tell me if {restaurant} is ONLINE or OFFLINE for web orders.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      method: generated
      generated: '2026-10-01'