Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Analytics Restaurants information API

2 actions 2 updates phrasing extends openapi/toast-restaurants-information-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['/restaurants-information'].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 Analytics Restaurants information API
  version: 1.0.0
extends: openapi/toast-restaurants-information-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['/restaurants-information'].get
  update:
    x-apievangelist-phrasing:
      intent: List restaurants in my management group
      effect: read
      questions:
      - Which restaurants are in my management group and are they activated?
      - Can I see which locations in my group are in test mode?
      instructions:
      - text: List every restaurant in my management group with its status.
      - text: Show which restaurants in my group are activated or in test mode.
      method: generated
      generated: '2026-10-01'