S&P Global · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LLM-ready Info API

4 actions 4 updates phrasing extends openapi/sp-global-info-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 4

$.info
$.paths['/api/v1/info/{company_id}'].get
$.paths['/api/v1/info/{company_id}/descriptions'].get
$.paths['/api/v1/info/{company_id}/names'].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 Info API
  version: 1.0.0
extends: openapi/sp-global-info-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: 3
- target: $.paths['/api/v1/info/{company_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's profile information
      effect: read
      questions:
      - How many employees does a company have and when was it founded?
      - Where is a company headquartered and what is its website?
      instructions:
      - text: Get general information for company {company_id}.
        slots:
          company_id: path.company_id
      - text: Show the status, industry, address and headcount of company {company_id}.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/info/{company_id}/descriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's business description
      effect: read
      questions:
      - What does this company actually do?
      - Can I get both a short summary and a long description of a business?
      instructions:
      - text: Get the summary and description for company {company_id}.
        slots:
          company_id: path.company_id
      - text: Describe what company {company_id} does in its long-form description.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/info/{company_id}/names'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's alternate and former names
      effect: read
      questions:
      - What was this company called before it renamed?
      - Does a company go by other names or have a native-language name?
      instructions:
      - text: List the alternate, historical and native names of company {company_id}.
        slots:
          company_id: path.company_id
      - text: Show former names for company {company_id}.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'