# 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 Items API
  version: 1.0.0
extends: openapi/lightspeed-items-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: 4
- target: $.paths['/items/v1/items/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a menu item
      effect: read
      questions:
      - What price and SKU does a particular menu item have?
      - Can I fetch a single item by ID for a business location?
      instructions:
      - text: Get item {id} at business location {location}.
        slots:
          id: path.id
          location: query.businessLocationId
      - text: Show the price and accounting group of item {id} at location {location}.
        slots:
          id: path.id
          location: query.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/items/v1/items/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a menu item
      effect: write
      questions:
      - Can I change the price of an existing item on the menu?
      - Which fields must I resend when updating an item?
      instructions:
      - text: 'Update item {id} at location {location}: name {name}, SKU {sku}, price {price}, accounting group {group}.'
        slots:
          id: path.id
          location: requestBody.businessLocationId
          name: requestBody.name
          sku: requestBody.sku
          price: requestBody.defaultPrice
          group: requestBody.accountingGroupId
      - text: Set item {id} at location {location} to price {price}, keeping name {name}, SKU {sku} and group {group}.
        slots:
          id: path.id
          location: requestBody.businessLocationId
          price: requestBody.defaultPrice
          name: requestBody.name
          sku: requestBody.sku
          group: requestBody.accountingGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/items/v1/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List or search menu items
      effect: read
      questions:
      - What items are on the menu at a restaurant location?
      - Can I search items by name, SKU or accounting group?
      instructions:
      - text: List items at business location {location}.
        slots:
          location: query.businessLocationId
      - text: Find items named {name} at location {location}.
        slots:
          name: query.name
          location: query.businessLocationId
      - text: Look up the item with SKU {sku} at location {location}.
        slots:
          sku: query.sku
          location: query.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/items/v1/items'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a menu item
      effect: write
      questions:
      - How do I add a new dish or drink to a location's menu?
      - Can I give a new item a cost price and barcode?
      instructions:
      - text: Create item {name} at location {location} priced {price} in accounting group {group}.
        slots:
          name: requestBody.name
          location: requestBody.businessLocationId
          price: requestBody.defaultPrice
          group: requestBody.accountingGroupId
      - text: Add menu item {name} with SKU {sku} at location {location}, price {price}, group {group}.
        slots:
          name: requestBody.name
          sku: requestBody.sku
          location: requestBody.businessLocationId
          price: requestBody.defaultPrice
          group: requestBody.accountingGroupId
      method: generated
      generated: '2026-09-26'