Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partners Connected Restaurants API

2 actions 2 updates phrasing extends openapi/toast-connectedrestaurants-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['/connectedRestaurants'].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 Partners Connected Restaurants API
  version: 1.0.0
extends: openapi/toast-connectedrestaurants-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['/connectedRestaurants'].get
  update:
    x-apievangelist-phrasing:
      intent: List restaurants connected to my integration
      effect: read
      questions:
      - Which restaurants have connected to my partner integration?
      - Can I page through connected restaurants and see only ones that changed recently?
      instructions:
      - text: List restaurants connected to my integration since {since}.
        slots:
          since: query.lastModified
      - text: Get the next page of connected restaurants using page token {token}.
        slots:
          token: query.pageToken
      method: generated
      generated: '2026-10-01'