AlgoVoi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Algovoi Co Uk Public API

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

$.info

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

$.paths['/subscription/{cancel_secret}/cancel'].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 Public API
  version: 1.0.0
extends: openapi/algovoi-co-uk-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: 2
- target: $.paths['/subscription/{cancel_secret}/cancel'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a subscription's cancel confirmation page
      effect: read
      questions:
      - What does a customer see when they open their subscription cancel link?
      - Does opening the cancel link cancel the subscription straight away?
      instructions:
      - text: Open the subscription cancel confirmation page for link {cancel_secret}.
        slots:
          cancel_secret: path.cancel_secret
      - text: Show the cancel page behind secret {cancel_secret} without committing.
        slots:
          cancel_secret: path.cancel_secret
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription/{cancel_secret}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit a subscription cancellation via its link
      effect: destructive
      questions:
      - How does a customer confirm cancelling a subscription from the single-use link?
      - Can the cancel link be used more than once?
      instructions:
      - text: Confirm cancellation of the subscription with cancel secret {cancel_secret}.
        slots:
          cancel_secret: path.cancel_secret
      - text: Commit the cancel from link {cancel_secret}.
        slots:
          cancel_secret: path.cancel_secret
      method: generated
      generated: '2026-10-01'