Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Analytics Check API

3 actions 3 updates phrasing extends openapi/toast-check-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['/check/{timeRange}'].post
$.paths['/check/{reportRequestGuid}'].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 Analytics Check API
  version: 1.0.0
extends: openapi/toast-check-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['/check/{timeRange}'].post
  update:
    x-apievangelist-phrasing:
      intent: Request check-level reporting data
      effect: write
      questions:
      - How do I request a report of checks for a range of business dates?
      - Can I limit a check report to inactive restaurants only?
      - Which time ranges are supported when requesting check reporting data?
      instructions:
      - text: Request {time_range} check data from {start} to {end} for restaurants {restaurants}.
        slots:
          time_range: path.timeRange
          start: requestBody.startBusinessDate
          end: requestBody.endBusinessDate
          restaurants: requestBody.restaurantIds
      - text: Start a daily check report from {start} to {end}, excluding restaurants {excluded}.
        slots:
          start: requestBody.startBusinessDate
          end: requestBody.endBusinessDate
          excluded: requestBody.excludedRestaurantIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/check/{reportRequestGuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch the results of a check report
      effect: read
      questions:
      - Where do I retrieve the check data once my check report request finishes?
      - Can check report results show guest-facing restaurant names?
      instructions:
      - text: Get the check report results for request {report}.
        slots:
          report: path.reportRequestGuid
      - text: Fetch check data for report {report} including restaurant names.
        slots:
          report: path.reportRequestGuid
      method: generated
      generated: '2026-10-01'