# 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 Purchase Orders API
  version: 1.0.0
extends: openapi/lightspeed-purchase-orders-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: 5
- target: $.paths['/purchase_orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List purchase orders
      effect: read
      questions:
      - What purchase orders do we have with our suppliers?
      - Can I page through purchase orders with cursor pagination?
      instructions:
      - text: List our purchase orders.
      - text: List purchase orders after cursor {after}, {page_size} per page.
        slots:
          after: query.after
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/purchase_orders/{purchase_order_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a purchase order
      effect: read
      questions:
      - How do I look up one purchase order by its ID?
      - Why are cost fields missing from a purchase order I fetched?
      instructions:
      - text: Get purchase order {purchase_order_id}.
        slots:
          purchase_order_id: path.purchase_order_id
      - text: Show the details of purchase order {purchase_order_id}.
        slots:
          purchase_order_id: path.purchase_order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/purchase_orders/{purchase_order_id}/deliveries'].get
  update:
    x-apievangelist-phrasing:
      intent: List deliveries on a purchase order
      effect: read
      questions:
      - Which deliveries have arrived against a purchase order?
      - Can a purchase order be received in more than one delivery?
      instructions:
      - text: List the deliveries for purchase order {purchase_order_id}.
        slots:
          purchase_order_id: path.purchase_order_id
      - text: Show shipments received on purchase order {purchase_order_id}, {page_size} per page.
        slots:
          purchase_order_id: path.purchase_order_id
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/purchase_orders/{purchase_order_id}/deliveries/{delivery_id}/line_items'].get
  update:
    x-apievangelist-phrasing:
      intent: List line items in a purchase order delivery
      effect: read
      questions:
      - What items came in on a particular delivery for a purchase order?
      - How do I see the received lines for one delivery?
      instructions:
      - text: List line items in delivery {delivery_id} of purchase order {purchase_order_id}.
        slots:
          delivery_id: path.delivery_id
          purchase_order_id: path.purchase_order_id
      - text: Show what was received in delivery {delivery_id} on purchase order {purchase_order_id}.
        slots:
          delivery_id: path.delivery_id
          purchase_order_id: path.purchase_order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/purchase_orders/{purchase_order_id}/line_items'].get
  update:
    x-apievangelist-phrasing:
      intent: List line items on a purchase order
      effect: read
      questions:
      - Which products and quantities were ordered on a purchase order?
      - How do I get all ordered lines of a purchase order regardless of delivery?
      instructions:
      - text: List the ordered line items on purchase order {purchase_order_id}.
        slots:
          purchase_order_id: path.purchase_order_id
      - text: Show every product ordered on purchase order {purchase_order_id}.
        slots:
          purchase_order_id: path.purchase_order_id
      method: generated
      generated: '2026-09-26'