Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Quotes API

3 actions 3 updates phrasing extends openapi/lightspeed-quotes-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['/quotes'].get

$.paths['/quotes/{quote_id}'].get

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 2026-07 Quotes API
  version: 1.0.0
extends: openapi/lightspeed-quotes-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['/quotes'].get
  update:
    x-apievangelist-phrasing:
      intent: List quotes
      effect: read
      questions:
      - What price quotes have we given customers?
      - Can I page through all saved quotes?
      instructions:
      - text: List all quotes.
      - text: Show the next {limit} quotes after {after}.
        slots:
          limit: query.limit
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/quotes/{quote_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a quote
      effect: read
      questions:
      - What items and prices are on a specific quote?
      - Can I retrieve one quote by its ID?
      instructions:
      - text: Get quote {quote}.
        slots:
          quote: path.quote_id
      - text: Show the line items on quote {quote}.
        slots:
          quote: path.quote_id
      method: generated
      generated: '2026-09-26'