Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lightspeed Restaurant K Series ID Cards API

3 actions 3 updates phrasing extends openapi/lightspeed-id-cards-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 3

$.info

$.paths['/id-cards/v1/business-locations/{businessLocationId}/batches'].post

$.paths['/id-cards/v1/business-locations/{businessLocationId}/batches/{batchId}/cards'].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 Lightspeed Restaurant K Series ID Cards API
  version: 1.0.0
extends: openapi/lightspeed-id-cards-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: 2
- target: $.paths['/id-cards/v1/business-locations/{businessLocationId}/batches'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a batch of ID cards
      effect: write
      questions:
      - How do I start a new batch of ID cards for a location?
      - What do I need to name a new ID card batch?
      instructions:
      - text: Create an ID card batch named {name} at location {businessLocationId}.
        slots:
          name: requestBody.name
          businessLocationId: path.businessLocationId
      - text: Start a new ID card batch {name} for business location {businessLocationId}.
        slots:
          name: requestBody.name
          businessLocationId: path.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/id-cards/v1/business-locations/{businessLocationId}/batches/{batchId}/cards'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate ID cards in an existing batch
      effect: write
      questions:
      - How do I generate a number of ID cards inside a batch?
      - Can I add more cards to an ID card batch I already created?
      instructions:
      - text: Create {cardCount} ID cards in batch {batchId} at location {businessLocationId}.
        slots:
          cardCount: requestBody.cardCount
          batchId: path.batchId
          businessLocationId: path.businessLocationId
      - text: Generate {cardCount} more cards for existing batch {batchId} at location {businessLocationId}.
        slots:
          cardCount: requestBody.cardCount
          batchId: path.batchId
          businessLocationId: path.businessLocationId
      method: generated
      generated: '2026-09-26'