Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Menus Metadata API

2 actions 2 updates phrasing extends openapi/toast-metadata-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['/metadata'].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 Menus Metadata API
  version: 1.0.0
extends: openapi/toast-metadata-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['/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Check when a restaurant's menu last changed
      effect: read
      questions:
      - How can I tell if a restaurant's menu data has been updated before downloading it again?
      - When was this restaurant's menu last modified?
      instructions:
      - text: Get the menu last-modified timestamp for restaurant {restaurant}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      - text: Check whether {restaurant}'s menu changed since I last synced.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      method: generated
      generated: '2026-10-01'