Uphold · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Widget Payment API

2 actions 2 updates phrasing extends openapi/uphold-payment-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 2

$.info
$.paths['/widgets/payment/sessions'].post

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 Widget Payment API
  version: 1.0.0
extends: openapi/uphold-payment-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: 1
- target: $.paths['/widgets/payment/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a Payment Widget session
      effect: write
      questions:
      - How do I launch the embedded Payment Widget for a user?
      - Is there a hosted widget for users to make payments?
      instructions:
      - text: Create a Payment Widget session.
      - text: Start the embedded payment widget for this user.
      method: generated
      generated: '2026-09-26'