S&P Global · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LLM-ready Relationship API

3 actions 3 updates phrasing extends openapi/sp-global-relationship-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/relationship/{company_id}/{relationship_type}'].get
$.paths['/api/v1/relationship/{company_id}/{relationship_type}/ticker'].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 Relationship API
  version: 1.0.0
extends: openapi/sp-global-relationship-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/relationship/{company_id}/{relationship_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List companies in a business relationship
      effect: read
      questions:
      - Who are a company's current and former landlords or tenants?
      - Can I see a company's suppliers by name?
      instructions:
      - text: List companies that are {relationship_type} of company {company_id}.
        slots:
          relationship_type: path.relationship_type
          company_id: path.company_id
      - text: Show current and previous {relationship_type} companies for company {company_id} by name.
        slots:
          relationship_type: path.relationship_type
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/relationship/{company_id}/{relationship_type}/ticker'].get
  update:
    x-apievangelist-phrasing:
      intent: List related companies as ticker ID triples
      effect: read
      questions:
      - Can I get the tradable securities of a company's customers or suppliers?
      - How do I get security and trading item IDs for a company's business partners?
      instructions:
      - text: Get ticker identification triples for the {relationship_type} of company {company_id}.
        slots:
          relationship_type: path.relationship_type
          company_id: path.company_id
      - text: List trading item IDs of companies that are {relationship_type} of {company_id}.
        slots:
          relationship_type: path.relationship_type
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'