S&P Global · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LLM-ready Securities API

3 actions 3 updates phrasing extends openapi/sp-global-securities-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/securities/{company_id}'].get

$.paths['/api/v1/securities/{company_id}/primary'].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 LLM-ready Securities API
  version: 1.0.0
extends: openapi/sp-global-securities-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/securities/{company_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's securities
      effect: read
      questions:
      - What securities has a company issued?
      - Can I get every security ID tied to a company?
      instructions:
      - text: List all securities for company {company_id}.
        slots:
          company_id: path.company_id
      - text: Get every security ID belonging to company {company_id}.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/securities/{company_id}/primary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's primary security
      effect: read
      questions:
      - Which is the main security for a company with several share classes?
      - What is a company's primary security ID?
      instructions:
      - text: Get the primary security for company {company_id}.
        slots:
          company_id: path.company_id
      - text: Find the main share class security of company {company_id}.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'