Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Toast Labor Jobs API

5 actions 5 updates phrasing extends openapi/toast-jobs-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 5

$.info

$.paths['/jobs'].get

$.paths['/jobs/{jobId}'].get

$.paths['/jobs/{jobId}/externalId'].put

$.paths['/jobs/{jobId}/externalId'].post

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 Jobs API
  version: 1.0.0
extends: openapi/toast-jobs-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: 4
- target: $.paths['/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee jobs at a restaurant
      effect: read
      questions:
      - Which employee jobs are configured at a restaurant?
      - Are deleted jobs included when I list jobs without specifying IDs?
      instructions:
      - text: List the jobs configured at restaurant {restaurant}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      - text: Get jobs {ids} at restaurant {restaurant}, including deleted ones.
        slots:
          ids: query.jobIds
          restaurant: header.Toast-Restaurant-External-ID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/jobs/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one job
      effect: read
      questions:
      - What details are stored for one specific employee job?
      - Can I fetch a single job by its ID?
      instructions:
      - text: Get job {job} at restaurant {restaurant}.
        slots:
          job: path.jobId
          restaurant: header.Toast-Restaurant-External-ID
      - text: Show me the details of job {job}.
        slots:
          job: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/jobs/{jobId}/externalId'].put
  update:
    x-apievangelist-phrasing:
      intent: Set or replace a job's external ID
      effect: write
      questions:
      - How do I overwrite the external identifier already on a job?
      - Can I replace a job's external ID with a new value?
      instructions:
      - text: Replace the external identifier on job {job}.
        slots:
          job: path.jobId
      - text: Overwrite job {job}'s external ID with a new value.
        slots:
          job: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/jobs/{jobId}/externalId'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an external ID to a job
      effect: write
      questions:
      - Can I attach an external identifier to a job that does not have one?
      - Why can I not change a job's external ID by posting again?
      instructions:
      - text: Attach a first external identifier to job {job}.
        slots:
          job: path.jobId
      - text: Give job {job} an external ID for the first time.
        slots:
          job: path.jobId
      method: generated
      generated: '2026-10-01'