Uphold · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Core External accounts API

6 actions 6 updates phrasing extends openapi/uphold-external-accounts-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 6

$.info

$.paths['/core/external-accounts'].get

$.paths['/core/external-accounts'].post

$.paths['/core/external-accounts/{externalAccountId}'].get

$.paths['/core/external-accounts/{externalAccountId}'].delete

$.paths['/core/external-accounts/{externalAccountId}'].patch

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 External accounts API
  version: 1.0.0
extends: openapi/uphold-external-accounts-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: 5
- target: $.paths['/core/external-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List linked external accounts
      effect: read
      questions:
      - Which external bank accounts or cards has this user linked?
      - How do I see all of a user's external accounts?
      instructions:
      - text: List my external accounts.
      - text: Show every linked external account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/external-accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Link an external account
      effect: write
      questions:
      - How do I link a bank account or card as an external account?
      - Can I add an external account for withdrawals?
      instructions:
      - text: Link a new external account for this user.
      - text: Add an external account to my profile.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/external-accounts/{externalAccountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one external account
      effect: read
      questions:
      - How do I look up a single linked external account?
      - What details are stored for an external account?
      instructions:
      - text: Get external account {externalAccountId}.
        slots:
          externalAccountId: path.externalAccountId
      - text: Show details of linked account {externalAccountId}.
        slots:
          externalAccountId: path.externalAccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/external-accounts/{externalAccountId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a linked external account
      effect: destructive
      questions:
      - How do I unlink an external account?
      - Can I delete a bank account I linked previously?
      instructions:
      - text: Delete external account {externalAccountId}.
        slots:
          externalAccountId: path.externalAccountId
      - text: Unlink the external account {externalAccountId}.
        slots:
          externalAccountId: path.externalAccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/external-accounts/{externalAccountId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a linked external account
      effect: write
      questions:
      - How do I change the label on a linked external account?
      - Can I rename an external account after linking it?
      instructions:
      - text: Rename external account {externalAccountId} to {label}.
        slots:
          externalAccountId: path.externalAccountId
          label: requestBody.label
      - text: Set the label of linked account {externalAccountId} to {label}.
        slots:
          externalAccountId: path.externalAccountId
          label: requestBody.label
      method: generated
      generated: '2026-09-26'