AlgoVoi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Algovoi Co Uk Recurr API

7 actions 7 updates phrasing extends openapi/algovoi-co-uk-recurr-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 7

$.info

$.paths['/v1/recurr/auth/challenge'].post

$.paths['/v1/recurr/auth/verify'].post

$.paths['/v1/recurr/me/subscriptions'].get

$.paths['/v1/recurr/me/subscriptions/{subscription_id}'].get

$.paths['/v1/recurr/me/subscriptions/{subscription_id}/cancel'].post

$.paths['/v1/recurr/me/invoices'].get

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 Recurr API
  version: 1.0.0
extends: openapi/algovoi-co-uk-recurr-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: 6
- target: $.paths['/v1/recurr/auth/challenge'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a wallet sign-in challenge for the portal
      effect: write
      questions:
      - How does a subscriber sign in to the customer portal with their wallet?
      - Which chain does the wallet login challenge need?
      instructions:
      - text: Get a sign-in nonce for wallet {wallet_address} on {chain}.
        slots:
          wallet_address: requestBody.wallet_address
          chain: requestBody.chain
      - text: Start wallet login for {wallet_address} on chain {chain}.
        slots:
          wallet_address: requestBody.wallet_address
          chain: requestBody.chain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recurr/auth/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a wallet signature to sign in
      effect: write
      questions:
      - After signing the nonce, how do I finish wallet login to the portal?
      - What do I send to prove I own the wallet?
      instructions:
      - text: Verify signature {signature} for nonce {nonce} and sign me in.
        slots:
          signature: requestBody.signature
          nonce: requestBody.nonce
      - text: Complete wallet login with signed nonce {nonce}.
        slots:
          nonce: requestBody.nonce
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recurr/me/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List my subscriptions across all merchants
      effect: read
      questions:
      - Which subscriptions is my wallet paying for across every merchant?
      - Can I see only my active subscriptions as a subscriber?
      instructions:
      - text: List all subscriptions billed to my wallet.
      - text: Show my {status} subscriptions across merchants.
        slots:
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recurr/me/subscriptions/{subscription_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one of my subscriptions
      effect: read
      questions:
      - What are the details of one subscription my wallet pays for?
      - Can a subscriber see the terms of a single subscription?
      instructions:
      - text: Show my subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: Get details of subscription {subscription_id} on my wallet.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recurr/me/subscriptions/{subscription_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel one of my subscriptions as a subscriber
      effect: destructive
      questions:
      - How do I cancel a subscription I'm paying for from the portal?
      - Can I stop a merchant's subscription billing my wallet myself?
      instructions:
      - text: Cancel my subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: Stop subscription {subscription_id} billing my wallet.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/recurr/me/invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List my invoices as a subscriber
      effect: read
      questions:
      - Which invoices has my wallet been charged?
      - Can I filter my invoices to one subscription?
      instructions:
      - text: List my invoices.
      - text: Show invoices for my subscription {subscription_id}.
        slots:
          subscription_id: query.subscription_id
      method: generated
      generated: '2026-10-01'