# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Platform REST Orders API
  version: 1.0.0
extends: openapi/vendasta-orders-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: 9
- target: $.paths['/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List a partner's orders
      effect: read
      questions:
      - What orders has my partner account placed?
      - Can I see only the orders for one business location?
      instructions:
      - text: List orders for partner {partner}.
        slots:
          partner: query.filter[partner.id]
      - text: Show orders for partner {partner} at business location {location}.
        slots:
          partner: query.filter[partner.id]
          location: query.filter[businessLocation.id]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an order for a business
      effect: write
      questions:
      - How do I place an order for products on behalf of a business?
      - Can an order be created as a draft or sent to admins for approval instead of processing right away?
      instructions:
      - text: Create an order {data} for a business.
        slots:
          data: requestBody.data
      - text: Place a draft order with {data} so I can finish it in the platform.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on the orders collection
      effect: read
      questions:
      - Which HTTP methods does the orders collection accept from a browser?
      - What does a CORS preflight to /orders return?
      instructions:
      - text: Send an OPTIONS preflight to the orders collection.
      - text: List permitted verbs for the orders list endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one order
      effect: read
      questions:
      - What is the current status and contents of a specific order?
      - Can I fetch an order's latest values by its ID?
      instructions:
      - text: Get order {id}.
        slots:
          id: path.id
      - text: Show me the current state of order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on a single order
      effect: read
      questions:
      - Which verbs can a browser use on one order's URL?
      - Does a single order resource answer CORS preflights?
      instructions:
      - text: Run a CORS preflight on order {id}.
        slots:
          id: path.id
      - text: Show allowed methods for the order {id} resource.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{id}/relationships/customFields'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the custom fields reference of an order
      effect: read
      questions:
      - What is the ID of the custom metadata record linked to an order?
      - Can I get only the relationship pointer to an order's custom data?
      instructions:
      - text: Get the custom fields relationship ID for order {id}.
        slots:
          id: path.id
      - text: Return just the reference to order {id}'s custom metadata.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{id}/relationships/customFields'].options
  update:
    x-apievangelist-phrasing:
      intent: Check methods on an order's custom field link
      effect: read
      questions:
      - Which verbs are allowed on an order's relationships/customFields link?
      - What CORS headers come back for the order custom field relationship path?
      instructions:
      - text: Preflight the relationships/customFields link of order {id}.
        slots:
          id: path.id
      - text: List allowed HTTP methods for the custom field relationship pointer on order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{id}/customFields'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order's custom field values
      effect: read
      questions:
      - What custom field values were captured on an order?
      - Can I read an order's custom attributes directly from the order path?
      instructions:
      - text: Show the custom field values on order {id}.
        slots:
          id: path.id
      - text: Get the custom attributes recorded for order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{id}/customFields'].options
  update:
    x-apievangelist-phrasing:
      intent: Check methods on an order's custom field values
      effect: read
      questions:
      - What HTTP methods does the customFields values path under an order support?
      - Can a browser reach an order's custom field values endpoint cross-origin?
      instructions:
      - text: Send an OPTIONS request to the customFields values path of order {id}.
        slots:
          id: path.id
      - text: Check which verbs the custom field values endpoint for order {id} allows.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'