# 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 Suppliers API
  version: 1.0.0
extends: openapi/lightspeed-suppliers-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['/suppliers'].get
  update:
    x-apievangelist-phrasing:
      intent: List suppliers
      effect: read
      questions:
      - Which suppliers do we buy stock from?
      - Can I include deleted suppliers in the supplier list?
      instructions:
      - text: List all our suppliers.
      - text: 'List suppliers including deleted ones: {deleted}.'
        slots:
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppliers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new supplier
      effect: write
      questions:
      - How do I add a new supplier with their contact details?
      - Can I set a default markup when creating a supplier?
      instructions:
      - text: Create a supplier named {name} with contact {contact}.
        slots:
          name: requestBody.name
          contact: requestBody.contact
      - text: Add new supplier {name}, contact {contact}, with a default markup of {default_markup}.
        slots:
          name: requestBody.name
          contact: requestBody.contact
          default_markup: requestBody.default_markup
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppliers/{supplier_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single supplier
      effect: read
      questions:
      - What contact details do we hold for a particular supplier?
      - How do I look up one supplier by its ID?
      instructions:
      - text: Get supplier {supplier_id}.
        slots:
          supplier_id: path.supplier_id
      - text: Show the contact info for supplier {supplier_id}.
        slots:
          supplier_id: path.supplier_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppliers/{supplier_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a supplier
      effect: write
      questions:
      - How do I change an existing supplier's contact or markup?
      - Can I rename a supplier we already have on file?
      instructions:
      - text: Update existing supplier {supplier_id} to name {name} and contact {contact}.
        slots:
          supplier_id: path.supplier_id
          name: requestBody.name
          contact: requestBody.contact
      - text: Change the default markup on supplier {supplier_id} to {default_markup}.
        slots:
          supplier_id: path.supplier_id
          default_markup: requestBody.default_markup
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppliers/{supplier_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a supplier
      effect: destructive
      questions:
      - What happens to products linked to a supplier when I delete it?
      - How do I remove a supplier we no longer use?
      instructions:
      - text: Delete supplier {supplier_id}.
        slots:
          supplier_id: path.supplier_id
      - text: Remove supplier {supplier_id} and unlink its products.
        slots:
          supplier_id: path.supplier_id
      method: generated
      generated: '2026-09-26'