Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Analytics Labor API

3 actions 3 updates phrasing extends openapi/toast-labor-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['/labor/{timeRange}'].post

$.paths['/labor/{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 Labor API
  version: 1.0.0
extends: openapi/toast-labor-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['/labor/{timeRange}'].post
  update:
    x-apievangelist-phrasing:
      intent: Request labor reporting data
      effect: write
      questions:
      - How do I request labor data for my restaurants over a date range?
      - Can I group labor report data, and can I limit it to inactive restaurants?
      instructions:
      - text: Request {time_range} labor 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 labor 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['/labor/{reportRequestGuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch labor report results
      effect: read
      questions:
      - Where do I get the labor numbers once my labor report request is ready?
      - What does a completed labor reporting request return?
      instructions:
      - text: Get the labor report results for request {report}.
        slots:
          report: path.reportRequestGuid
      - text: Fetch the labor data for report {report}.
        slots:
          report: path.reportRequestGuid
      method: generated
      generated: '2026-10-01'