AlgoVoi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Algovoi Co Uk Recurr Public API

4 actions 4 updates phrasing extends openapi/algovoi-co-uk-recurr-public-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['/recurr/portal'].get

$.paths['/recurr/cancel/{cancel_secret}'].get

$.paths['/recurr/cancel/{cancel_secret}'].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 Recurr Public API
  version: 1.0.0
extends: openapi/algovoi-co-uk-recurr-public-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['/recurr/portal'].get
  update:
    x-apievangelist-phrasing:
      intent: Open the subscriber customer portal
      effect: read
      questions:
      - Where can a customer connect a wallet and see every subscription billing it?
      - Which wallets does the subscriber portal support?
      instructions:
      - text: Open the subscriber portal.
      - text: Load the customer portal for chain {chain}.
        slots:
          chain: query.chain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/recurr/cancel/{cancel_secret}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the portal cancel page for a subscription
      effect: read
      questions:
      - What does the recurr portal cancel link show before I confirm?
      - Can I preview a recurring-payment cancellation from the portal link?
      instructions:
      - text: Open the recurr cancel page for {cancel_secret}.
        slots:
          cancel_secret: path.cancel_secret
      - text: Show the portal's cancel preview behind link {cancel_secret}.
        slots:
          cancel_secret: path.cancel_secret
      method: generated
      generated: '2026-10-01'
- target: $.paths['/recurr/cancel/{cancel_secret}'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm cancellation from the portal link
      effect: destructive
      questions:
      - How do I confirm a cancellation from the recurr portal link?
      - Is cancelling through the recurr cancel link final?
      instructions:
      - text: Commit the recurr cancellation for {cancel_secret}.
        slots:
          cancel_secret: path.cancel_secret
      - text: Confirm the portal cancel link {cancel_secret}.
        slots:
          cancel_secret: path.cancel_secret
      method: generated
      generated: '2026-10-01'