S&P Global · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LLM-ready Merger API

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

$.paths['/api/v1/merger/info/{transaction_id}/advisors/{advised_company_id}'].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 Merger API
  version: 1.0.0
extends: openapi/sp-global-merger-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/merger/info/{transaction_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of an M&A transaction
      effect: read
      questions:
      - Who were the buyers and sellers in a specific acquisition?
      - Can I see the status history and consideration of a merger deal?
      instructions:
      - text: Get details for merger transaction {transaction_id}.
        slots:
          transaction_id: path.transaction_id
      - text: Show the target, buyers, sellers and status changes of deal {transaction_id}.
        slots:
          transaction_id: path.transaction_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/merger/info/{transaction_id}/advisors/{advised_company_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get advisors to a party in an M&A deal
      effect: read
      questions:
      - Which banks advised a company on its acquisition?
      - What roles did advisors play for one party in a merger?
      instructions:
      - text: List advisors for company {advised_company_id} in merger {transaction_id}.
        slots:
          advised_company_id: path.advised_company_id
          transaction_id: path.transaction_id
      - text: Show who advised {advised_company_id} on deal {transaction_id} and in what role.
        slots:
          advised_company_id: path.advised_company_id
          transaction_id: path.transaction_id
      method: generated
      generated: '2026-10-01'