Uphold · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Core Capabilities API

3 actions 3 updates phrasing extends openapi/uphold-capabilities-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/capabilities'].get

$.paths['/core/capabilities/{capability}'].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 Capabilities API
  version: 1.0.0
extends: openapi/uphold-capabilities-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/capabilities'].get
  update:
    x-apievangelist-phrasing:
      intent: List what a user is allowed to do
      effect: read
      questions:
      - Which capabilities does this user currently have, like trading or withdrawing?
      - How do I see all the actions a user is enabled for?
      instructions:
      - text: List all capabilities for this user.
      - text: Show every capability I have and whether it is enabled.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/capabilities/{capability}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one user capability
      effect: read
      questions:
      - Can this user withdraw right now, and if not, why?
      - How do I check the status of one specific capability?
      instructions:
      - text: Check the {capability} capability for this user.
        slots:
          capability: path.capability
      - text: Get my {capability} capability status.
        slots:
          capability: path.capability
      method: generated
      generated: '2026-09-26'