Upstox · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI definition News API

2 actions 2 updates phrasing extends openapi/upstox-news-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 2

$.info

$.paths['/v2/news'].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 News API
  version: 1.0.0
extends: openapi/upstox-news-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: 1
- target: $.paths['/v2/news'].get
  update:
    x-apievangelist-phrasing:
      intent: Get news for stocks or my portfolio
      effect: read
      questions:
      - What's the latest news on the stocks I hold?
      - Can I get news articles about my open positions?
      - How do I fetch headlines for specific instruments?
      instructions:
      - text: Get news for category {category}.
        slots:
          category: query.category
      - text: Show news articles about {instrument_keys} using category {category}.
        slots:
          instrument_keys: query.instrument_keys
          category: query.category
      - text: Fetch page {page_number} of {category} news, {page_size} per page.
        slots:
          page_number: query.page_number
          category: query.category
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'