Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com R3pv API

6 actions 6 updates phrasing extends openapi/thehiveryiq-com-r3pv-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Hive Civilization's API. It is a proposal applied on top of the contract, not a document Hive Civilization publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/v1/r3pv/health'].get
$.paths['/v1/r3pv/groups'].post
$.paths['/v1/r3pv/groups/{group_id}'].get
$.paths['/v1/r3pv/vector'].get
$.paths['/v1/r3pv/vector'].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 Thehiveryiq Com R3pv API
  version: 1.0.0
extends: openapi/thehiveryiq-com-r3pv-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v1/r3pv/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Discover R3Pv version and signer details
      effect: read
      questions:
      - Which version of the receipt proof-vector service is running and which signer does it use?
      - What healing states and vector dimensions does R3Pv report?
      instructions:
      - text: Get the R3Pv discovery and health info.
      - text: Show R3Pv's vector dimensions, healing states and signer.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/r3pv/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a receipt group
      effect: write
      questions:
      - How do I bundle several receipts into one group for later proofs?
      - Can I build a receipt group from receipt IDs instead of full receipts?
      instructions:
      - text: Create a receipt group labelled {label} from receipt IDs {receipt_ids}.
        slots:
          label: requestBody.label
          receipt_ids: requestBody.receipt_ids
      - text: 'Group these inline receipts together: {receipts}.'
        slots:
          receipts: requestBody.receipts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/r3pv/groups/{group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a stored receipt group
      effect: read
      questions:
      - How do I look up a receipt group I created earlier?
      - Which receipts are in a given group?
      instructions:
      - text: Get receipt group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show the receipts stored in group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/r3pv/vector'].get
  update:
    x-apievangelist-phrasing:
      intent: Compute a signed proof vector for a group
      effect: read
      questions:
      - How do I get a signed proof vector for an existing receipt group?
      - Can I compute the proof vector just from a group ID?
      instructions:
      - text: Compute the signed proof vector for stored group {group_id}.
        slots:
          group_id: query.group_id
      - text: Get the proof vector of existing receipt group {group_id}.
        slots:
          group_id: query.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/r3pv/vector'].post
  update:
    x-apievangelist-phrasing:
      intent: Group receipts and compute a vector in one call
      effect: write
      questions:
      - Can I group receipts and get their proof vector in a single request?
      - Do I have to persist the group when computing a vector from inline receipts?
      instructions:
      - text: Build a group from receipts {receipts} and return its signed proof vector.
        slots:
          receipts: requestBody.receipts
      - text: Compute a proof vector for receipt IDs {receipt_ids} in one call, persist set to {persist}.
        slots:
          receipt_ids: requestBody.receipt_ids
          persist: requestBody.persist
      method: generated
      generated: '2026-09-26'