S&P Global · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LLM-ready Trading Items API

3 actions 3 updates phrasing extends openapi/sp-global-trading-items-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for S&P Global's API. It is a proposal applied on top of the contract, not a document S&P Global publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/api/v1/trading_items/{security_id}'].get
$.paths['/api/v1/trading_items/{security_id}/primary'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for LLM-ready Trading Items API
  version: 1.0.0
extends: openapi/sp-global-trading-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: 2
- target: $.paths['/api/v1/trading_items/{security_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a security's trading items
      effect: read
      questions:
      - On which listings does a security trade?
      - Can I get every trading item ID for a security?
      instructions:
      - text: List trading items for security {security_id}.
        slots:
          security_id: path.security_id
      - text: Get all trading item IDs of security {security_id}.
        slots:
          security_id: path.security_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/trading_items/{security_id}/primary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a security's primary trading item
      effect: read
      questions:
      - What is the main listing for a security that trades in several places?
      - Which trading item ID should I use for a security's prices?
      instructions:
      - text: Get the primary trading item for security {security_id}.
        slots:
          security_id: path.security_id
      - text: Find the main listing of security {security_id}.
        slots:
          security_id: path.security_id
      method: generated
      generated: '2026-10-01'