AlgoVoi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Algovoi Co Uk Mandate Portal API

4 actions 4 updates phrasing extends openapi/algovoi-co-uk-mandate-portal-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for AlgoVoi's API. It is a proposal applied on top of the contract, not a document AlgoVoi publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/mandate/portal/{mandate_id}'].get

$.paths['/mandate/portal/{mandate_id}/topup/initiate'].post

$.paths['/mandate/portal/{mandate_id}/topup/capture'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Algovoi Co Uk Mandate Portal API
  version: 1.0.0
extends: openapi/algovoi-co-uk-mandate-portal-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/mandate/portal/{mandate_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a mandate's balance and recent charges
      effect: read
      questions:
      - What is my mandate's balance and its last few charges?
      - Can the mandate portal show my active JWT token?
      instructions:
      - text: Show the portal view for mandate {mandate_id}.
        slots:
          mandate_id: path.mandate_id
      - text: Get mandate {mandate_id}'s balance, status and token.
        slots:
          mandate_id: path.mandate_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mandate/portal/{mandate_id}/topup/initiate'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a PayPal top-up for a mandate
      effect: write
      questions:
      - How do I add funds to my mandate with PayPal?
      - Where does the buyer go to approve a mandate top-up?
      instructions:
      - text: Top up mandate {mandate_id} by {amount_minor} via PayPal, returning to {return_url} or {cancel_url}.
        slots:
          mandate_id: path.mandate_id
          amount_minor: requestBody.amount_minor
          return_url: requestBody.return_url
          cancel_url: requestBody.cancel_url
      - text: Start a {amount_minor} PayPal top-up on mandate {mandate_id}.
        slots:
          amount_minor: requestBody.amount_minor
          mandate_id: path.mandate_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mandate/portal/{mandate_id}/topup/capture'].post
  update:
    x-apievangelist-phrasing:
      intent: Capture an approved PayPal mandate top-up
      effect: write
      questions:
      - After the buyer approves in PayPal, how do I capture the top-up?
      - Is it safe to retry capturing a top-up if the first call timed out?
      instructions:
      - text: Capture PayPal order {token} for mandate {mandate_id}.
        slots:
          token: query.token
          mandate_id: path.mandate_id
      - text: Finish the approved top-up {token} on mandate {mandate_id}.
        slots:
          token: query.token
          mandate_id: path.mandate_id
      method: generated
      generated: '2026-10-01'