Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Toast Labor Shifts API

6 actions 6 updates phrasing extends openapi/toast-shifts-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 6

$.info

$.paths['/shifts'].get

$.paths['/shifts'].post

$.paths['/shifts/{shiftId}'].get

$.paths['/shifts/{shiftId}'].put

$.paths['/shifts/{shiftId}'].delete

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 Toast Labor Shifts API
  version: 1.0.0
extends: openapi/toast-shifts-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: 5
- target: $.paths['/shifts'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled employee shifts
      effect: read
      questions:
      - Which employee shifts are scheduled between two dates?
      - Can I fetch a specific set of shifts by their IDs?
      instructions:
      - text: List scheduled shifts at {restaurant} from {start} to {end}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
          start: query.startDate
          end: query.endDate
      - text: Get shifts {ids} at restaurant {restaurant}.
        slots:
          ids: query.shiftIds
          restaurant: header.Toast-Restaurant-External-ID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shifts'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a new employee shift
      effect: write
      questions:
      - How do I add a scheduled shift for an employee?
      - Can I create schedule shifts through the API?
      instructions:
      - text: Create a scheduled shift at restaurant {restaurant}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      - text: Schedule a new shift for an employee at {restaurant}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shifts/{shiftId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one scheduled shift
      effect: read
      questions:
      - What are the details of one particular scheduled shift?
      - Can I get a single shift record by its ID?
      instructions:
      - text: Get shift {shift} at restaurant {restaurant}.
        slots:
          shift: path.shiftId
          restaurant: header.Toast-Restaurant-External-ID
      - text: Show me scheduled shift {shift}.
        slots:
          shift: path.shiftId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shifts/{shiftId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an existing shift
      effect: write
      questions:
      - How do I change the times of a shift that is already scheduled?
      - Does updating a shift replace the whole record?
      instructions:
      - text: Update shift {shift} with the new schedule.
        slots:
          shift: path.shiftId
      - text: Replace shift {shift} at restaurant {restaurant} with this record.
        slots:
          shift: path.shiftId
          restaurant: header.Toast-Restaurant-External-ID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shifts/{shiftId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scheduled shift
      effect: destructive
      questions:
      - What happens if I delete a shift that was already deleted?
      - Can I remove a shift from an employee's schedule?
      instructions:
      - text: Delete shift {shift}.
        slots:
          shift: path.shiftId
      - text: Remove scheduled shift {shift} at restaurant {restaurant}.
        slots:
          shift: path.shiftId
          restaurant: header.Toast-Restaurant-External-ID
      method: generated
      generated: '2026-10-01'