# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salla Shipping API
  version: 1.0.0
extends: openapi/salla-shipping-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/shipments'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipments
      effect: read
      questions:
      - Which shipments exist in my Salla store?
      - Can I list every shipment the shop has made?
      instructions:
      - text: List all shipments.
      - text: Show every shipment in my store.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shipment
      effect: write
      questions:
      - How do I create a new shipment?
      - Can I start a shipment from the shipping API?
      instructions:
      - text: Create a new shipment.
      - text: Start a new shipment for the store.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipments/{shipment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipment's details
      effect: read
      questions:
      - What details are recorded for a particular shipment?
      - Can I fetch one shipment by its ID?
      instructions:
      - text: Show me shipment {shipment_id}.
        slots:
          shipment_id: path.shipment_id
      - text: Get shipment {shipment_id} details.
        slots:
          shipment_id: path.shipment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipping/zones'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping zones
      effect: read
      questions:
      - Which areas does my store ship to?
      - Can I see the shipping zones that are configured?
      instructions:
      - text: List my shipping zones.
      - text: Show the regions my store delivers to.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipping/zones/{zone_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipping zone
      effect: read
      questions:
      - What does a specific shipping zone cover?
      - Can I look up one shipping zone by its ID?
      instructions:
      - text: Show shipping zone {zone_id}.
        slots:
          zone_id: path.zone_id
      - text: Get details of shipping zone {zone_id}.
        slots:
          zone_id: path.zone_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipping/companies'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping companies
      effect: read
      questions:
      - Which shipping companies or couriers are set up for my store?
      - Can I see all the carriers the shop uses?
      instructions:
      - text: List my shipping companies.
      - text: Show the couriers configured for my store.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipping/companies'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a shipping company
      effect: write
      questions:
      - How do I add my own shipping company to the store?
      - Can I register a new courier for deliveries?
      instructions:
      - text: Create a new shipping company.
      - text: Add a courier to my store's shipping companies.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipping/companies/{company_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipping company
      effect: read
      questions:
      - What settings are stored for one shipping company?
      - Can I look up a courier by its ID?
      instructions:
      - text: Show shipping company {company_id}.
        slots:
          company_id: path.company_id
      - text: Get details of courier {company_id}.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipping/companies/{company_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a shipping company
      effect: write
      questions:
      - How do I change the settings of an existing shipping company?
      - Can I edit a courier I already added?
      instructions:
      - text: Update shipping company {company_id}.
        slots:
          company_id: path.company_id
      - text: Edit the existing courier {company_id}.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipping/companies/{company_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shipping company
      effect: destructive
      questions:
      - How do I remove a shipping company I no longer use?
      - Can I delete a courier from the store?
      instructions:
      - text: Delete shipping company {company_id}.
        slots:
          company_id: path.company_id
      - text: Remove courier {company_id} from my store.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'