API Evangelist conversational phrasing for OpenAPI definition Order API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OpenAPI definition Order API
  version: 1.0.0
extends: openapi/upstox-order-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: 18
- target: $.paths['/v3/order/modify'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify an open order (v3)
      effect: write
      questions:
      - How do I change the price of a pending order using the v3 order API?
      - Can I switch an open v3 order from limit to market?
      instructions:
      - text: Using v3, modify order {order_id} to {order_type} at {price}, trigger {trigger_price}, validity {validity}.
        slots:
          order_id: requestBody.order_id
          order_type: requestBody.order_type
          price: requestBody.price
          trigger_price: requestBody.trigger_price
          validity: requestBody.validity
      - text: Via v3 change the quantity of order {order_id} to {quantity}, keeping {order_type} at {price}, trigger {trigger_price}, {validity}.
        slots:
          order_id: requestBody.order_id
          quantity: requestBody.quantity
          order_type: requestBody.order_type
          price: requestBody.price
          trigger_price: requestBody.trigger_price
          validity: requestBody.validity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/order/gtt/modify'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a GTT order
      effect: write
      questions:
      - How do I change the trigger rules on my good-till-triggered order?
      - Can I update the quantity of an existing GTT?
      instructions:
      - text: Update GTT {gtt_order_id} to {type} with quantity {quantity} and rules {rules}.
        slots:
          gtt_order_id: requestBody.gtt_order_id
          type: requestBody.type
          quantity: requestBody.quantity
          rules: requestBody.rules
      - text: Change the trigger rules of GTT order {gtt_order_id} to {rules}, type {type}, qty {quantity}.
        slots:
          gtt_order_id: requestBody.gtt_order_id
          rules: requestBody.rules
          type: requestBody.type
          quantity: requestBody.quantity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/order/modify'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify an open order (older v2)
      effect: write
      questions:
      - How do I modify a pending order on the older v2 endpoint?
      - Which fields keep their original values if I leave them out of a v2 modify?
      instructions:
      - text: Through the v2 endpoint, modify order {order_id} to {order_type} at {price}, trigger {trigger_price}, validity {validity}.
        slots:
          order_id: requestBody.order_id
          order_type: requestBody.order_type
          price: requestBody.price
          trigger_price: requestBody.trigger_price
          validity: requestBody.validity
      - text: With the legacy v2 modify, set disclosed quantity of {order_id} to {disclosed_quantity}, {order_type} at {price}, trigger {trigger_price}, {validity}.
        slots:
          order_id: requestBody.order_id
          disclosed_quantity: requestBody.disclosed_quantity
          order_type: requestBody.order_type
          price: requestBody.price
          trigger_price: requestBody.trigger_price
          validity: requestBody.validity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/order/place'].post
  update:
    x-apievangelist-phrasing:
      intent: Place an order (v3, with auto-slicing)
      effect: write
      questions:
      - How do I place a buy order with the v3 order API?
      - Can the v3 place endpoint slice a large order automatically?
      - Can I place an after-market order with v3?
      instructions:
      - text: Using v3, {transaction_type} {quantity} of {instrument_token} as a {order_type} order at {price}, product {product}.
        slots:
          transaction_type: requestBody.transaction_type
          quantity: requestBody.quantity
          instrument_token: requestBody.instrument_token
          order_type: requestBody.order_type
          price: requestBody.price
          product: requestBody.product
      - text: Via v3, {transaction_type} {quantity} {instrument_token} with auto-slicing set to {slice}.
        slots:
          transaction_type: requestBody.transaction_type
          quantity: requestBody.quantity
          instrument_token: requestBody.instrument_token
          slice: requestBody.slice
      - text: Place a v3 after-market order (is_amo {is_amo}) to {transaction_type} {quantity} of {instrument_token}.
        slots:
          is_amo: requestBody.is_amo
          transaction_type: requestBody.transaction_type
          quantity: requestBody.quantity
          instrument_token: requestBody.instrument_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/order/gtt/place'].post
  update:
    x-apievangelist-phrasing:
      intent: Place a GTT order
      effect: write
      questions:
      - How do I set a good-till-triggered order that fires when a price is hit?
      - Can I create a multi-leg GTT with a target and stop loss?
      instructions:
      - text: Place a {type} GTT to {transaction_type} {quantity} of {instrument_token} as {product} with rules {rules}.
        slots:
          type: requestBody.type
          transaction_type: requestBody.transaction_type
          quantity: requestBody.quantity
          instrument_token: requestBody.instrument_token
          product: requestBody.product
          rules: requestBody.rules
      - text: Set a good-till-triggered {transaction_type} on {instrument_token}, qty {quantity}, {product}, type {type}, triggers {rules}.
        slots:
          transaction_type: requestBody.transaction_type
          instrument_token: requestBody.instrument_token
          quantity: requestBody.quantity
          product: requestBody.product
          type: requestBody.type
          rules: requestBody.rules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/order/positions/exit'].post
  update:
    x-apievangelist-phrasing:
      intent: Exit all open positions
      effect: destructive
      questions:
      - How do I square off all my open positions at once?
      - Can I exit only the positions in one segment or with a certain tag?
      instructions:
      - text: Exit all my open positions.
      - text: Square off every position in segment {segment}.
        slots:
          segment: query.segment
      - text: Close all positions tagged {tag}.
        slots:
          tag: query.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/order/place'].post
  update:
    x-apievangelist-phrasing:
      intent: Place an order (older v2)
      effect: write
      questions:
      - How do I place an order on the older v2 place endpoint?
      - Can I tag an order placed through v2 so I can find it later?
      instructions:
      - text: Via the older v2 endpoint, {transaction_type} {quantity} of {instrument_token} as {order_type} at {price}, product {product}.
        slots:
          transaction_type: requestBody.transaction_type
          quantity: requestBody.quantity
          instrument_token: requestBody.instrument_token
          order_type: requestBody.order_type
          price: requestBody.price
          product: requestBody.product
      - text: Place a legacy v2 {transaction_type} of {quantity} {instrument_token} tagged {tag}.
        slots:
          transaction_type: requestBody.transaction_type
          quantity: requestBody.quantity
          instrument_token: requestBody.instrument_token
          tag: requestBody.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/order/multi/place'].post
  update:
    x-apievangelist-phrasing:
      intent: Place several orders in one request
      effect: write
      questions:
      - Can I send a basket of orders to the exchange in a single call?
      - How do I place multiple orders together instead of one at a time?
      instructions:
      - text: Place this basket of orders in one request.
      - text: Submit all of these orders together as a multi-order.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/order/gtt'].get
  update:
    x-apievangelist-phrasing:
      intent: Get GTT order details
      effect: read
      questions:
      - What GTT orders do I have set up and what are their triggers?
      - Has my good-till-triggered order fired yet?
      instructions:
      - text: Show all my GTT orders.
      - text: Get the details of GTT order {gtt_order_id}.
        slots:
          gtt_order_id: query.gtt_order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/order/trades'].get
  update:
    x-apievangelist-phrasing:
      intent: List trades executed for an order
      effect: read
      questions:
      - How many fills did one of my orders get and at what prices?
      - Was my order executed in parts?
      instructions:
      - text: List the trades executed for order {order_id}.
        slots:
          order_id: query.order_id
      - text: Show fill prices and quantities for order {order_id}.
        slots:
          order_id: query.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/order/trades/get-trades-for-day'].get
  update:
    x-apievangelist-phrasing:
      intent: List today's executed trades
      effect: read
      questions:
      - What trades have I executed today?
      - Which of today's orders actually got filled?
      instructions:
      - text: List all trades executed today.
      - text: Show my tradebook for the day.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/order/retrieve-all'].get
  update:
    x-apievangelist-phrasing:
      intent: List today's orders
      effect: read
      questions:
      - What orders have I placed today, including open and filled ones?
      - Where can I see my full order book for the current session?
      instructions:
      - text: Show my order book for today.
      - text: List every order I placed this session with its state.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/order/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status history of an order
      effect: read
      questions:
      - What status changes has one of my orders gone through today?
      - Can I trace an order's history using the tag I gave it?
      instructions:
      - text: Get the order history of {order_id}.
        slots:
          order_id: query.order_id
      - text: Show the lifecycle of the order tagged {tag}.
        slots:
          tag: query.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/order/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest details of an order
      effect: read
      questions:
      - What is the current status of a specific order?
      - Is my order still open or has it been filled?
      instructions:
      - text: Get the latest details of order {order_id}.
        slots:
          order_id: query.order_id
      - text: Check whether order {order_id} is open, rejected or complete.
        slots:
          order_id: query.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/order/gtt/cancel'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a GTT order
      effect: destructive
      questions:
      - How do I delete a good-till-triggered order I no longer need?
      - Can I cancel a GTT before it triggers?
      instructions:
      - text: Cancel GTT order {gtt_order_id}.
        slots:
          gtt_order_id: requestBody.gtt_order_id
      - text: Remove my good-till-triggered order {gtt_order_id}.
        slots:
          gtt_order_id: requestBody.gtt_order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/order/cancel'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an order (v3)
      effect: destructive
      questions:
      - How do I cancel a pending order using the v3 order API?
      - What does the v3 cancel endpoint need to cancel an order?
      instructions:
      - text: Using v3, cancel order {order_id}.
        slots:
          order_id: query.order_id
      - text: Cancel pending order {order_id} through the v3 endpoint.
        slots:
          order_id: query.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/order/multi/cancel'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel all open orders
      effect: destructive
      questions:
      - Can I cancel every open and pending order in one go?
      - Is there a way to cancel only the open orders in one segment?
      instructions:
      - text: Cancel all my open and pending orders.
      - text: Cancel every open order in segment {segment}.
        slots:
          segment: query.segment
      - text: Cancel all pending orders tagged {tag}.
        slots:
          tag: query.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/order/cancel'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel or exit an order (older v2)
      effect: destructive
      questions:
      - How do I exit a cover order or OCO bracket order?
      - Can the older v2 cancel endpoint cancel an after-market order?
      instructions:
      - text: Via the v2 endpoint, cancel order {order_id}.
        slots:
          order_id: query.order_id
      - text: Exit my cover or bracket order {order_id}.
        slots:
          order_id: query.order_id
      method: generated
      generated: '2026-09-26'