Toast · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Device details API

Overlay of API Evangelist annotations for Toast's published Device details API 1.0.0. It adds provenance, the documented cross-cutting runtime semantics Toast publishes only in prose, and an explicit warning that the servers[] host is a placeholder. It adds nothing that Toast does not itself publish and it does not modify the original definition, which stays verbatim at the extends target.

3 actions 3 updates update extends openapi/toast-device-details-openapi.yaml

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-api-evangelistx-host-not-publishedx-host-notex-host-evidence-urlx-tenancy-headerx-rate-limitx-paginationx-idempotency

Targets 2

$.info

$.servers[0]

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Device details API
  version: 1.0.0
  description: Overlay of API Evangelist annotations for Toast's published Device details API 1.0.0. It
    adds provenance, the documented cross-cutting runtime semantics Toast publishes only in prose, and
    an explicit warning that the servers[] host is a placeholder. It adds nothing that Toast does not
    itself publish and it does not modify the original definition, which stays verbatim at the extends
    target.
extends: openapi/toast-device-details-openapi.yaml
x-generated: '2026-08-27'
x-method: generated
actions:
- target: $.info
  update:
    x-api-evangelist:
      harvested: '2026-08-27'
      harvested-from: https://doc.toasttab.com/openapi/page-data/device-details/overview/page-data.json
      provider: Toast
      provider-id: toast
      note: Verbatim from the Redocly-rendered Toast API reference on Toast's own documentation host.
- target: $.servers[0]
  update:
    x-host-not-published: true
    x-host-note: '`toast-api-server` is a placeholder Toast publishes in place of a real hostname. The
      Toast developer guide states hostnames are issued privately by the Toast integrations team (sandbox
      at build start, production at go-live). The PATH below the host is real and correct; the host is
      not resolvable and must be substituted with the hostname Toast issues you. See https://doc.toasttab.com/doc/devguide/apiEnvironments.html'
    x-host-evidence-url: https://doc.toasttab.com/doc/devguide/apiExampleRequests.html
- target: $.info
  update:
    x-tenancy-header: Toast-Restaurant-External-ID
    x-rate-limit:
      global: 20/second, 10000/15 minutes
      per-api: 20/second, 10000/15 minutes
      status-on-exhaustion: 429
      headers:
      - X-Toast-RateLimit-By
      - X-Toast-RateLimit-Remaining
      - X-Toast-RateLimit-Reset
      source: https://doc.toasttab.com/doc/devguide/apiRateLimiting.html
    x-pagination:
      style: opaque page token
      request-param: pageToken
      response-header: Toast-Next-Page-Token
      source: https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html
    x-idempotency:
      supported: false
      note: Toast publishes no idempotency key header for inbound APIs.
    x-error-envelope:
      format: proprietary ErrorMessage JSON
      rfc9457: false
      artifact: errors/toast-problem-types.yml