Upstox · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI definition Mutual Fund API

5 actions 5 updates phrasing extends openapi/upstox-mutual-fund-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Upstox's API. It is a proposal applied on top of the contract, not a document Upstox publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/v2/mf/sips'].get

$.paths['/v2/mf/orders'].get

$.paths['/v2/mf/orders/{order_id}'].get

$.paths['/v2/mf/holdings'].get

OpenAPI Overlay

# 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 Mutual Fund API
  version: 1.0.0
extends: openapi/upstox-mutual-fund-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: 4
- target: $.paths['/v2/mf/sips'].get
  update:
    x-apievangelist-phrasing:
      intent: List my mutual fund SIPs
      effect: read
      questions:
      - Which SIPs do I have running or paused?
      - What systematic investment plans are set up on my account?
      instructions:
      - text: List my active and paused SIPs.
      - text: Show page {page_number} of my SIPs with {records} per page.
        slots:
          page_number: query.page_number
          records: query.records
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/mf/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent mutual fund orders
      effect: read
      questions:
      - What mutual fund orders did I place in the last week?
      - Can I filter my recent fund orders to redemptions only?
      - Which of my mutual fund purchases are still pending?
      instructions:
      - text: List my mutual fund orders from the last 7 days.
      - text: Show my {transaction_type} fund orders with status {status}.
        slots:
          transaction_type: query.transaction_type
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/mf/orders/{order_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a mutual fund order
      effect: read
      questions:
      - What happened to a specific mutual fund order I placed?
      - Has my fund purchase been allotted units yet?
      instructions:
      - text: Get mutual fund order {order_id}.
        slots:
          order_id: path.order_id
      - text: Check the status of fund order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/mf/holdings'].get
  update:
    x-apievangelist-phrasing:
      intent: List my mutual fund holdings
      effect: read
      questions:
      - Which mutual funds do I currently hold and how many units?
      - What is my mutual fund portfolio worth?
      instructions:
      - text: Show my mutual fund holdings.
      - text: List the funds and units in my MF portfolio.
      method: generated
      generated: '2026-09-26'