Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Configuration Tax Rates API

3 actions 3 updates phrasing extends openapi/toast-tax-rates-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['/taxRates/{guid}'].get
$.paths['/taxRates'].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 Configuration Tax Rates API
  version: 1.0.0
extends: openapi/toast-tax-rates-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['/taxRates/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one tax rate
      effect: read
      questions:
      - How do I see the details of one tax rate applied to sales?
      - What is configured on a single tax rate?
      instructions:
      - text: Get tax rate {guid} for restaurant {restaurant}.
        slots:
          guid: path.guid
          restaurant: header.Toast-Restaurant-External-ID
      - text: Show me tax rate {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/taxRates'].get
  update:
    x-apievangelist-phrasing:
      intent: List a restaurant's tax rates
      effect: read
      questions:
      - Which tax rates are applied to sales at a restaurant?
      - Can I list only tax rates changed since a date?
      instructions:
      - text: List tax rates for restaurant {restaurant}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      - text: List tax rates at {restaurant} modified since {since}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
          since: query.lastModified
      method: generated
      generated: '2026-10-01'