Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Shifts API

2 actions 2 updates phrasing extends openapi/lightspeed-shifts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Lightspeed Commerce's API. It is a proposal applied on top of the contract, not a document Lightspeed Commerce publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/shifts'].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 2026-07 Shifts API
  version: 1.0.0
extends: openapi/lightspeed-shifts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/shifts'].get
  update:
    x-apievangelist-phrasing:
      intent: List shifts
      effect: read
      questions:
      - What shifts have been recorded in my retail store?
      - Can I page through older shifts?
      instructions:
      - text: List all shifts.
      - text: Show {size} shifts recorded after {after}.
        slots:
          size: query.page_size
          after: query.after
      method: generated
      generated: '2026-09-26'