Uphold · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Core Users API

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

$.info
$.paths['/core/users'].post
$.paths['/core/users/me'].get
$.paths['/core/users/me'].delete

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 Users API
  version: 1.0.0
extends: openapi/uphold-users-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: 3
- target: $.paths['/core/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new user
      effect: write
      questions:
      - How do I create a new end user on the platform?
      - Can I create a business user rather than an individual?
      instructions:
      - text: Create a new user.
      - text: Create a user of type {type}.
        slots:
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/users/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current user's profile
      effect: read
      questions:
      - How do I fetch the profile of the signed-in user?
      - Who is the user I'm acting as right now?
      instructions:
      - text: Show my user profile.
      - text: Get the user I am acting on behalf of, {X-On-Behalf-Of}.
        slots:
          X-On-Behalf-Of: header.X-On-Behalf-Of
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/users/me'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the current user
      effect: destructive
      questions:
      - How do I delete a user's account entirely?
      - What is required to close and remove a user?
      instructions:
      - text: Delete my user account.
      - text: Delete the current user with review {review}.
        slots:
          review: requestBody.review
      method: generated
      generated: '2026-09-26'