S&P Global · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LLM-ready Competitors API

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

$.paths['/api/v1/competitors/{company_id}/{competitor_source}'].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 Competitors API
  version: 1.0.0
extends: openapi/sp-global-competitors-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/competitors/{company_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's competitors
      effect: read
      questions:
      - Who are this company's competitors?
      - Can I get a company's full competitor list from every source at once?
      instructions:
      - text: List all competitors of company {company_id}.
        slots:
          company_id: path.company_id
      - text: Show who competes with company {company_id}, regardless of source.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/competitors/{company_id}/{competitor_source}'].get
  update:
    x-apievangelist-phrasing:
      intent: List competitors from a specific source
      effect: read
      questions:
      - Which competitors does a company name in its SEC filings?
      - Can I see only the competitors that other companies say they compete with this one?
      instructions:
      - text: List competitors of company {company_id} sourced from {competitor_source}.
        slots:
          company_id: path.company_id
          competitor_source: path.competitor_source
      - text: Show company {company_id}'s competitors that came from SEC filings, using source {competitor_source}.
        slots:
          company_id: path.company_id
          competitor_source: path.competitor_source
      method: generated
      generated: '2026-10-01'