Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stock API

4 actions 4 updates phrasing extends openapi/toast-stock-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['/v1/inventory'].get

$.paths['/v1/inventory/search'].post

$.paths['/v1/inventory/update'].put

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 Stock API
  version: 1.0.0
extends: openapi/toast-stock-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['/v1/inventory'].get
  update:
    x-apievangelist-phrasing:
      intent: List menu items that are out of stock or limited
      effect: read
      questions:
      - Which menu items are out of stock or running on a limited quantity?
      - Why are in-stock items missing from the inventory list?
      instructions:
      - text: List out-of-stock and limited-quantity items at {restaurant}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      - text: List menu items at {restaurant} with stock status {status}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/inventory/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Check stock for specific menu items
      effect: read
      questions:
      - Can I check the stock status of a particular list of menu items?
      - Can I look up inventory by multi-location ID instead of GUID?
      instructions:
      - text: Check inventory for menu items {guids} at {restaurant}.
        slots:
          guids: requestBody.guids
          restaurant: header.Toast-Restaurant-External-ID
      - text: Look up stock for multi-location IDs {ids}.
        slots:
          ids: requestBody.multiLocationIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/inventory/update'].put
  update:
    x-apievangelist-phrasing:
      intent: Update stock for specific menu items
      effect: write
      questions:
      - How do I mark a menu item as out of stock?
      - Can I set the remaining quantity for several items at once?
      instructions:
      - text: Update inventory for these menu items at {restaurant}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      - text: Mark the listed items out of stock at restaurant {restaurant}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      method: generated
      generated: '2026-10-01'