S&P Global · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LLM-ready Company Groups API

5 actions 5 updates phrasing extends openapi/sp-global-company-groups-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 5

$.info
$.paths['/api/v1/company_groups/geo/country/{iso_code}/{state}'].get
$.paths['/api/v1/company_groups/industry/{industry_classification}/{industry_code}'].get
$.paths['/api/v1/company_groups/industry/gics/{gics_code}'].get
$.paths['/api/v1/company_groups/industry/simple/{simple_industry}'].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 Company Groups API
  version: 1.0.0
extends: openapi/sp-global-company-groups-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: 4
- target: $.paths['/api/v1/company_groups/geo/country/{iso_code}/{state}'].get
  update:
    x-apievangelist-phrasing:
      intent: List companies headquartered in a state or region
      effect: read
      questions:
      - Which companies are based in California?
      - Can I get every company located in a particular province of a country?
      instructions:
      - text: List companies based in state {state} of country {iso_code}.
        slots:
          state: path.state
          iso_code: path.iso_code
      - text: Find all companies located in {iso_code} subdivision {state}.
        slots:
          iso_code: path.iso_code
          state: path.state
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/company_groups/industry/{industry_classification}/{industry_code}'].get
  update:
    x-apievangelist-phrasing:
      intent: List companies by an industry classification code
      effect: read
      questions:
      - Can I find companies by their SIC or NAICS industry code?
      - Which companies fall under a given code in a specific industry classification system?
      instructions:
      - text: List companies with {industry_classification} code {industry_code}.
        slots:
          industry_classification: path.industry_classification
          industry_code: path.industry_code
      - text: Find every company classified under {industry_code} in the {industry_classification} scheme.
        slots:
          industry_code: path.industry_code
          industry_classification: path.industry_classification
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/company_groups/industry/gics/{gics_code}'].get
  update:
    x-apievangelist-phrasing:
      intent: List companies in a GICS sector or industry
      effect: read
      questions:
      - Which companies belong to the GICS Information Technology sector?
      - Can I pull companies by a 6- or 8-digit GICS sub-industry code?
      instructions:
      - text: List companies with GICS code {gics_code}.
        slots:
          gics_code: path.gics_code
      - text: Get every company in GICS sector {gics_code}.
        slots:
          gics_code: path.gics_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/company_groups/industry/simple/{simple_industry}'].get
  update:
    x-apievangelist-phrasing:
      intent: List companies in a simple industry
      effect: read
      questions:
      - What companies are in the Semiconductors industry?
      - How do I get all companies tagged with a plain-language industry name?
      instructions:
      - text: List companies in the {simple_industry} industry.
        slots:
          simple_industry: path.simple_industry
      - text: Find all company IDs whose simple industry is {simple_industry}.
        slots:
          simple_industry: path.simple_industry
      method: generated
      generated: '2026-10-01'