Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Mpp API

5 actions 5 updates phrasing extends openapi/thehiveryiq-com-mpp-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Hive Civilization's API. It is a proposal applied on top of the contract, not a document Hive Civilization publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/receipt/mpp/health'].get
$.paths['/v1/receipt/mpp'].post
$.paths['/v1/receipt/mpp/spt'].post
$.paths['/.well-known/mpp.json'].get

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 Thehiveryiq Com Mpp API
  version: 1.0.0
extends: openapi/thehiveryiq-com-mpp-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['/v1/receipt/mpp/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check MPP receipt minting configuration
      effect: read
      questions:
      - Is MPP payment configured for minting receipts yet?
      - Can I check the MPP health before paying for a receipt?
      instructions:
      - text: Check MPP health.
      - text: Show whether MPP receipt minting is configured.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/mpp'].post
  update:
    x-apievangelist-phrasing:
      intent: Mint a receipt paid through MPP
      effect: write
      questions:
      - How do I mint a post-quantum receipt and pay for it with an MPP 402 challenge over Stripe?
      - What happens on the first MPP mint call when I have no payment credential?
      instructions:
      - text: Mint a receipt over {payload} paid via MPP.
        slots:
          payload: requestBody.payload
      - text: Mint a {profile} receipt for {payload} labeled {label} using MPP.
        slots:
          profile: requestBody.profile
          payload: requestBody.payload
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/mpp/spt'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Stripe Shared Payment Token
      effect: write
      questions:
      - How does an MPP client get a Stripe Shared Payment Token for a payment method?
      - What amount, currency and expiry do I pass to create a shared payment token?
      instructions:
      - text: Create a shared payment token for {paymentMethod} for {amount} {currency} on network {networkId}, expiring {expiresAt}.
        slots:
          paymentMethod: requestBody.paymentMethod
          amount: requestBody.amount
          currency: requestBody.currency
          networkId: requestBody.networkId
          expiresAt: requestBody.expiresAt
      - text: Grant an SPT from {paymentMethod} worth {amount} {currency}, network {networkId}, expires {expiresAt}, reference {externalId}.
        slots:
          paymentMethod: requestBody.paymentMethod
          amount: requestBody.amount
          currency: requestBody.currency
          networkId: requestBody.networkId
          expiresAt: requestBody.expiresAt
          externalId: requestBody.externalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/.well-known/mpp.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the MPP service discovery manifest
      effect: read
      questions:
      - Where is the MPP discovery manifest for auto-discovery by aggregators?
      - What does the well-known mpp.json file advertise?
      instructions:
      - text: Fetch the MPP discovery manifest.
      - text: Show the well-known mpp.json.
      method: generated
      generated: '2026-09-26'