Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Order Management Configuration Ordering Schedule API

2 actions 2 updates phrasing extends openapi/toast-ordering-schedule-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['/published/orderingSchedule'].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 Order Management Configuration Ordering Schedule API
  version: 1.0.0
extends: openapi/toast-ordering-schedule-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['/published/orderingSchedule'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a location's online ordering schedule
      effect: read
      questions:
      - What hours does a restaurant location accept online orders?
      - Can I see the online ordering schedule for one location?
      instructions:
      - text: Get the online ordering schedule for restaurant {restaurant}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      - text: Show when {restaurant} takes online orders.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      method: generated
      generated: '2026-10-01'