# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Edge Ordering Service-Customer Order Items…
  version: 1.0.0
extends: openapi/microsoft-azure-order-items-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: 8
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orderItems'].get
  update:
    x-apievangelist-phrasing:
      intent: List Edge hardware order items in a subscription
      effect: read
      questions:
      - Which Azure Edge hardware order items have I placed across my subscription?
      - Can I filter or expand details on subscription-wide order items?
      instructions:
      - text: List all Edge order items across the whole subscription.
      - text: List Edge order items in my subscription matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems'].get
  update:
    x-apievangelist-phrasing:
      intent: List order items in a resource group
      effect: read
      questions:
      - What Edge hardware order items are in one resource group?
      - How do I page through order items for a resource group with a skip token?
      instructions:
      - text: List the Edge order items in this resource group only.
      - text: Show resource-group order items matching {filter}, {top} at a time.
        slots:
          filter: query.$filter
          top: query.$top
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Edge hardware order item
      effect: read
      questions:
      - How do I check the shipping and status details of one order item?
      - Can I expand extra details when fetching a single order item?
      instructions:
      - text: Show order item {orderItemName}.
        slots:
          orderItemName: path.orderItemName
      - text: Get order item {orderItemName} with {expand} expanded.
        slots:
          orderItemName: path.orderItemName
          expand: query.$expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Place a new Edge hardware order item
      effect: write
      questions:
      - How do I order Azure Edge hardware as a new order item?
      - Can I change an existing order item by creating it again?
      instructions:
      - text: Create order item {orderItemName}.
        slots:
          orderItemName: path.orderItemName
      - text: Place a new Edge hardware order item named {orderItemName} with these properties.
        slots:
          orderItemName: path.orderItemName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an order item
      effect: destructive
      questions:
      - Can I delete an order item record from my resource group?
      - Is deleting an Edge order item permanent?
      instructions:
      - text: Delete order item {orderItemName}.
        slots:
          orderItemName: path.orderItemName
      - text: Remove the order item {orderItemName}.
        slots:
          orderItemName: path.orderItemName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing order item
      effect: write
      questions:
      - How do I change the properties or tags on an order item I already placed?
      - Can I guard an order item update with an ETag?
      instructions:
      - text: Update order item {orderItemName}.
        slots:
          orderItemName: path.orderItemName
      - text: Set tags {tags} on existing order item {orderItemName}.
        slots:
          tags: requestBody.tags
          orderItemName: path.orderItemName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an order item
      effect: destructive
      questions:
      - How do I cancel Edge hardware I ordered but no longer want?
      - Does cancelling an order item require a reason?
      instructions:
      - text: Cancel order item {orderItemName} because {reason}.
        slots:
          orderItemName: path.orderItemName
          reason: requestBody.reason
      - text: Cancel order item {orderItemName} with reason {reason}.
        slots:
          orderItemName: path.orderItemName
          reason: requestBody.reason
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}/return'].post
  update:
    x-apievangelist-phrasing:
      intent: Return an order item's hardware
      effect: write
      questions:
      - How do I send Edge hardware back once I'm done with it?
      - Can I ask for a shipping box when returning an order item?
      instructions:
      - text: Return order item {orderItemName} because {returnReason}.
        slots:
          orderItemName: path.orderItemName
          returnReason: requestBody.returnReason
      - text: 'Start a return for order item {orderItemName} with reason {returnReason} and ship a box: {shippingBoxRequired}.'
        slots:
          orderItemName: path.orderItemName
          returnReason: requestBody.returnReason
          shippingBoxRequired: requestBody.shippingBoxRequired
      method: generated
      generated: '2026-10-01'