Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Receipt Ledger API

6 actions 6 updates phrasing extends openapi/thehiveryiq-com-receipt-ledger-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/receipts'].get
$.paths['/v1/receipts'].post
$.paths['/v1/receipts/summary'].get
$.paths['/v1/receipts/pubkey'].get
$.paths['/v1/receipts/verify/{seq}'].get

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 Receipt Ledger API
  version: 1.0.0
extends: openapi/thehiveryiq-com-receipt-ledger-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/receipts'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the receipt ledger
      effect: read
      questions:
      - Which ledger entries were recorded for a particular supermodel?
      - Can I filter the receipt ledger by event type, direction or minimum amount?
      instructions:
      - text: Show the latest receipt ledger entries.
      - text: List {direction} ledger entries of type {event_type} for supermodel {supermodel_id} over {min_amount} USDC.
        slots:
          direction: query.direction
          event_type: query.event_type
          supermodel_id: query.supermodel_id
          min_amount: query.min_amount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipts'].post
  update:
    x-apievangelist-phrasing:
      intent: Append an entry to the receipt ledger
      effect: write
      questions:
      - How do I add a new signed entry to the append-only receipt ledger?
      - What event types and directions can a ledger entry have?
      instructions:
      - text: Append a {direction} {event_type} entry to the ledger.
        slots:
          direction: requestBody.direction
          event_type: requestBody.event_type
      - text: Record a {direction} {event_type} of {amount_usdc} USDC for supermodel {supermodel_id} in the ledger.
        slots:
          direction: requestBody.direction
          event_type: requestBody.event_type
          amount_usdc: requestBody.amount_usdc
          supermodel_id: requestBody.supermodel_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipts/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize the receipt ledger
      effect: read
      questions:
      - What are the aggregate totals across the entire receipt ledger?
      - How much has flowed in and out overall according to the ledger?
      instructions:
      - text: Summarize the receipt ledger.
      - text: Give me aggregate stats for all ledger entries.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipts/pubkey'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the ledger's signing public key
      effect: read
      questions:
      - Which Ed25519 public key signs the receipt ledger entries?
      - Can I fetch the ledger key once and verify receipts offline?
      instructions:
      - text: Fetch the receipt ledger's public key.
      - text: Get the Ed25519 key I need to verify ledger entries offline.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipts/verify/{seq}'].get
  update:
    x-apievangelist-phrasing:
      intent: Verify one ledger entry's signature
      effect: read
      questions:
      - How do I prove a specific ledger entry hasn't been tampered with?
      - Does ledger verification give me a proof an auditor can replay?
      instructions:
      - text: Verify ledger entry {seq}.
        slots:
          seq: path.seq
      - text: Produce a replayable signature proof for ledger sequence {seq}.
        slots:
          seq: path.seq
      method: generated
      generated: '2026-09-26'