S&P Global · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LLM-ready Users API

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

$.info

$.paths['/api/v1/users/permissions'].get

$.paths['/api/v1/users/refresh_access_token'].get

$.paths['/api/v1/users/refresh_access_token'].post

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 Users API
  version: 1.0.0
extends: openapi/sp-global-users-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: 3
- target: $.paths['/api/v1/users/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List my account's data permissions
      effect: read
      questions:
      - Which datasets am I permitted to access?
      - What permissions does my user have?
      instructions:
      - text: List my permissions.
      - text: Show every permission granted to my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users/refresh_access_token'].get
  update:
    x-apievangelist-phrasing:
      intent: Refresh an access token via GET
      effect: write
      questions:
      - Can I refresh my access token with a simple GET request?
      - My access token expired - is there a GET call to renew it?
      instructions:
      - text: Refresh my access token using the GET endpoint.
      - text: Renew my expired token with the GET refresh call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users/refresh_access_token'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange a refresh token for a new access token
      effect: write
      questions:
      - How do I get a new access token by posting my refresh token?
      - Can I swap a valid refresh token for a fresh access token?
      instructions:
      - text: Refresh my access token with refresh token {refresh_token}.
        slots:
          refresh_token: requestBody.refresh_token
      - text: Exchange {refresh_token} for a new access token.
        slots:
          refresh_token: requestBody.refresh_token
      method: generated
      generated: '2026-10-01'