AlgoVoi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Algovoi Co Uk Mesh Federation API

3 actions 3 updates phrasing extends openapi/algovoi-co-uk-mesh-federation-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['/suite-store/mesh-fed/provision'].post

$.paths['/suite-store/mesh-fed/info'].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 Mesh Federation API
  version: 1.0.0
extends: openapi/algovoi-co-uk-mesh-federation-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['/suite-store/mesh-fed/provision'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a mesh federation certificate
      effect: write
      questions:
      - How do I get a mesh federation certificate for my customer licence?
      - Why would mesh provisioning return 403 for my licence?
      instructions:
      - text: Provision a federation cert for licence {license_key} in namespace {namespace} with key {fed_pub_b64}.
        slots:
          license_key: requestBody.license_key
          namespace: requestBody.namespace
          fed_pub_b64: requestBody.fed_pub_b64
      - text: Issue a mesh cert for {license_key} valid for {ttl_secs} seconds.
        slots:
          license_key: requestBody.license_key
          ttl_secs: requestBody.ttl_secs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/suite-store/mesh-fed/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the mesh federation service is live
      effect: read
      questions:
      - Is the mesh federation provisioning service reachable before I install?
      - What does the installer check before provisioning?
      instructions:
      - text: Check the mesh federation info endpoint.
      - text: Run the installer's liveness probe for mesh federation.
      method: generated
      generated: '2026-10-01'