Uphold · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Core Terms of service API

4 actions 4 updates phrasing extends openapi/uphold-terms-of-service-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/terms-of-service'].get
$.paths['/core/terms-of-service/{termsOfService}'].get
$.paths['/core/terms-of-service/{termsOfService}/accept'].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 Core Terms of service API
  version: 1.0.0
extends: openapi/uphold-terms-of-service-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/terms-of-service'].get
  update:
    x-apievangelist-phrasing:
      intent: List applicable terms of service
      effect: read
      questions:
      - Which terms of service apply to users in a given country?
      - Can I filter terms of service by user type, such as business?
      instructions:
      - text: List the platform's terms of service.
      - text: Show terms of service for {userType} users in {country}.
        slots:
          userType: query.userType
          country: query.country
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/terms-of-service/{termsOfService}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one terms of service document
      effect: read
      questions:
      - How do I read a specific terms of service document?
      - What does a particular terms of service code contain?
      instructions:
      - text: Get terms of service {termsOfService}.
        slots:
          termsOfService: path.termsOfService
      - text: Show me the text of terms {termsOfService}.
        slots:
          termsOfService: path.termsOfService
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/terms-of-service/{termsOfService}/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept terms of service
      effect: write
      questions:
      - How do I record that a user accepted the terms of service?
      - Does a user have to accept terms before using the platform?
      instructions:
      - text: Accept terms of service {termsOfService}.
        slots:
          termsOfService: path.termsOfService
      - text: Record my acceptance of {termsOfService}.
        slots:
          termsOfService: path.termsOfService
      method: generated
      generated: '2026-09-26'