Uphold · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Core Metadata API

5 actions 5 updates phrasing extends openapi/uphold-metadata-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 5

$.info
$.paths['/core/{entity}/{entityId}/metadata'].get
$.paths['/core/{entity}/{entityId}/metadata'].put
$.paths['/core/{entity}/{entityId}/metadata'].delete
$.paths['/core/{entity}/{entityId}/metadata'].patch

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Core Metadata API
  version: 1.0.0
extends: openapi/uphold-metadata-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: 4
- target: $.paths['/core/{entity}/{entityId}/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get custom metadata on a record
      effect: read
      questions:
      - How do I read the custom metadata attached to an account or transaction?
      - Where can I see key-value metadata stored on an entity?
      instructions:
      - text: Get the metadata on {entity} {entityId}.
        slots:
          entity: path.entity
          entityId: path.entityId
      - text: Show custom metadata for {entity} with id {entityId}.
        slots:
          entity: path.entity
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/{entity}/{entityId}/metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace metadata on a record
      effect: write
      questions:
      - How do I attach my own metadata to an account or transaction?
      - Can I overwrite all the metadata on an entity at once?
      instructions:
      - text: Set the metadata on {entity} {entityId}.
        slots:
          entity: path.entity
          entityId: path.entityId
      - text: Replace all metadata on {entity} {entityId}.
        slots:
          entity: path.entity
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/{entity}/{entityId}/metadata'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete metadata from a record
      effect: destructive
      questions:
      - How do I remove all custom metadata from an entity?
      - Can I clear metadata I previously attached?
      instructions:
      - text: Delete the metadata on {entity} {entityId}.
        slots:
          entity: path.entity
          entityId: path.entityId
      - text: Clear all custom metadata from {entity} {entityId}.
        slots:
          entity: path.entity
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/{entity}/{entityId}/metadata'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update metadata on a record
      effect: write
      questions:
      - How do I change a few metadata keys without replacing the rest?
      - Can I patch existing metadata with optimistic concurrency?
      instructions:
      - text: Update existing metadata on {entity} {entityId}.
        slots:
          entity: path.entity
          entityId: path.entityId
      - text: Patch some metadata keys on {entity} {entityId} if the version is {If-Match}.
        slots:
          entity: path.entity
          entityId: path.entityId
          If-Match: header.If-Match
      method: generated
      generated: '2026-09-26'