Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Toast Restaurants API

3 actions 3 updates phrasing extends openapi/toast-restaurants-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['/restaurants'].get
$.paths['/restaurants/{restaurantGUID}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Toast Restaurants API
  version: 1.0.0
extends: openapi/toast-restaurants-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['/restaurants'].get
  update:
    x-apievangelist-phrasing:
      intent: List restaurants my client can access
      effect: read
      questions:
      - Which restaurants can my partner API client access?
      - Can I list only accessible restaurants that changed since a date?
      instructions:
      - text: List the restaurants my partner client can access.
      - text: List accessible restaurants modified since {since}.
        slots:
          since: query.lastModified
      method: generated
      generated: '2026-10-01'
- target: $.paths['/restaurants/{restaurantGUID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a restaurant's configuration
      effect: read
      questions:
      - How do I get the detailed configuration of one restaurant?
      - Can the restaurant configuration include archived settings?
      instructions:
      - text: Get configuration for restaurant {restaurant_guid}.
        slots:
          restaurant_guid: path.restaurantGUID
      - text: Show restaurant {restaurant_guid}'s setup including archived items.
        slots:
          restaurant_guid: path.restaurantGUID
      method: generated
      generated: '2026-10-01'