AlgoVoi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Algovoi Co Uk Recurring Hosted Auth API

3 actions 3 updates phrasing extends openapi/algovoi-co-uk-recurring-hosted-auth-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 3

$.info
$.paths['/v1/recurring/auth/{token}'].get
$.paths['/v1/recurring/auth/{token}/confirm'].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 Algovoi Co Uk Recurring Hosted Auth API
  version: 1.0.0
extends: openapi/algovoi-co-uk-recurring-hosted-auth-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: 2
- target: $.paths['/v1/recurring/auth/{token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Resolve a hosted-auth signing token
      effect: read
      questions:
      - What authority summary does a hosted-auth signing link show the customer?
      - Why does an expired hosted-auth token return 410 Gone?
      instructions:
      - text: Resolve hosted-auth token {token}.
        slots:
          token: path.token
      - text: Show the authority summary for signing link {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recurring/auth/{token}/confirm'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm a hosted-auth token and activate authority
      effect: write
      questions:
      - How does the hosted-auth page activate an authority once the wallet transaction lands?
      - Is the customer's wallet sanctions-screened before an authority goes active?
      instructions:
      - text: Confirm hosted-auth token {token} with on-chain address {on_chain_address}.
        slots:
          token: path.token
          on_chain_address: requestBody.on_chain_address
      - text: Activate the authority for signing link {token} using tx {on_chain_tx_id}.
        slots:
          token: path.token
          on_chain_tx_id: requestBody.on_chain_tx_id
      method: generated
      generated: '2026-10-01'