AlgoVoi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Algovoi Co Uk Customers API

3 actions 3 updates phrasing extends openapi/algovoi-co-uk-customers-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/customers'].get
$.paths['/v1/customers'].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 Customers API
  version: 1.0.0
extends: openapi/algovoi-co-uk-customers-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/customers'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers
      effect: read
      questions:
      - Which customers do I have on file?
      - Can I page through my customer list with a limit and offset?
      instructions:
      - text: List my customers.
      - text: Show {limit} customers starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/customers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer
      effect: write
      questions:
      - How do I add a new customer with an email and wallet address?
      - Can I attach metadata when creating a customer?
      instructions:
      - text: Create a customer with email {email}.
        slots:
          email: requestBody.email
      - text: Add customer {email} with wallet {wallet_address}.
        slots:
          email: requestBody.email
          wallet_address: requestBody.wallet_address
      method: generated
      generated: '2026-10-01'