Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Configuration Service Areas API

3 actions 3 updates phrasing extends openapi/toast-service-areas-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['/serviceAreas/{guid}'].get
$.paths['/serviceAreas'].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 Configuration Service Areas API
  version: 1.0.0
extends: openapi/toast-service-areas-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['/serviceAreas/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one service area
      effect: read
      questions:
      - How do I see one physical service area, like the patio?
      - What details are stored for a single service area?
      instructions:
      - text: Get service area {guid} for restaurant {restaurant}.
        slots:
          guid: path.guid
          restaurant: header.Toast-Restaurant-External-ID
      - text: Show me service area {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/serviceAreas'].get
  update:
    x-apievangelist-phrasing:
      intent: List a restaurant's service areas
      effect: read
      questions:
      - Which service areas, such as dining room and patio, does a restaurant have?
      - Can I list only service areas changed since a date?
      instructions:
      - text: List service areas for restaurant {restaurant}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      - text: List service areas at {restaurant} modified since {since}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
          since: query.lastModified
      method: generated
      generated: '2026-10-01'