S&P Global · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LLM-ready Auditors API

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

$.info
$.paths['/api/v1/auditors/'].post

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 Auditors API
  version: 1.0.0
extends: openapi/sp-global-auditors-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: 1
- target: $.paths['/api/v1/auditors/'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up a company's financial auditors
      effect: read
      questions:
      - Who audits this company's financial statements?
      - Can I see which audit firms a company used over a range of years?
      - Which accounting firm signed off on a company's books in a given fiscal year?
      instructions:
      - text: List the auditors of company {company_id}.
        slots:
          company_id: requestBody.company_id
      - text: Show the auditors for company {company_id} from {start_year} to {end_year}.
        slots:
          company_id: requestBody.company_id
          start_year: requestBody.start_year
          end_year: requestBody.end_year
      method: generated
      generated: '2026-10-01'