Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Analytics Menu API

4 actions 4 updates phrasing extends openapi/toast-menu-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 4

$.info

$.paths['/menu'].post

$.paths['/menu/{timeRange}'].post

$.paths['/menu/{reportRequestGuid}'].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 Analytics Menu API
  version: 1.0.0
extends: openapi/toast-menu-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: 3
- target: $.paths['/menu'].post
  update:
    x-apievangelist-phrasing:
      intent: Request menu sales data for custom dates
      effect: write
      questions:
      - How do I request menu performance data for any start and end business date?
      - Can a custom-range menu report cover only inactive restaurants?
      instructions:
      - text: Request menu data from {start} to {end} for restaurants {restaurants}.
        slots:
          start: requestBody.startBusinessDate
          end: requestBody.endBusinessDate
          restaurants: requestBody.restaurantIds
      - text: Start a custom-range menu report from {start} to {end} grouped by {group_by}.
        slots:
          start: requestBody.startBusinessDate
          end: requestBody.endBusinessDate
          group_by: requestBody.groupBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/menu/{timeRange}'].post
  update:
    x-apievangelist-phrasing:
      intent: Request menu data for a preset time range
      effect: write
      questions:
      - Can I request menu reporting data for a fixed period like one day?
      - Which preset time ranges work for menu reporting requests?
      instructions:
      - text: Run a preset {time_range} menu report covering {start} through {end} for {restaurants}.
        slots:
          time_range: path.timeRange
          start: requestBody.startBusinessDate
          end: requestBody.endBusinessDate
          restaurants: requestBody.restaurantIds
      - text: Start a {time_range} menu report from {start} to {end} excluding {excluded}.
        slots:
          time_range: path.timeRange
          start: requestBody.startBusinessDate
          end: requestBody.endBusinessDate
          excluded: requestBody.excludedRestaurantIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/menu/{reportRequestGuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch menu report results
      effect: read
      questions:
      - Where do I retrieve menu reporting data after my request completes?
      - What comes back from a finished menu report request?
      instructions:
      - text: Get the menu report results for request {report}.
        slots:
          report: path.reportRequestGuid
      - text: Fetch the menu data for report {report}.
        slots:
          report: path.reportRequestGuid
      method: generated
      generated: '2026-10-01'