Uphold · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Core Countries API

3 actions 3 updates phrasing extends openapi/uphold-countries-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Uphold's API. It is a proposal applied on top of the contract, not a document Uphold publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/core/countries'].get

$.paths['/core/countries/{country}'].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 Core Countries API
  version: 1.0.0
extends: openapi/uphold-countries-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/core/countries'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported countries
      effect: read
      questions:
      - Which countries are supported on the platform?
      - Where can users sign up and operate?
      instructions:
      - text: List all supported countries.
      - text: Show me every country the platform supports.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/countries/{country}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details for one country
      effect: read
      questions:
      - What are the details and support status for a specific country?
      - How do I look up one country by its code?
      instructions:
      - text: Get the country {country}.
        slots:
          country: path.country
      - text: Show platform details for country code {country}.
        slots:
          country: path.country
      method: generated
      generated: '2026-09-26'