Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com R9 Accumulators API

9 actions 9 updates phrasing extends openapi/thehiveryiq-com-r9-accumulators-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 9

$.info
$.paths['/v1/accumulator/policy'].get
$.paths['/v1/accumulator/anchor'].post
$.paths['/v1/accumulator/{domain}/root'].get
$.paths['/v1/accumulator/{domain}/leaves'].get
$.paths['/v1/accumulator/{domain}/replay'].get
$.paths['/v1/accumulator/{domain}/inclusion'].get
$.paths['/v1/accumulator/{domain}/non-membership'].get
$.paths['/v1/accumulator/verify'].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 R9 Accumulators API
  version: 1.0.0
extends: openapi/thehiveryiq-com-r9-accumulators-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: 8
- target: $.paths['/v1/accumulator/policy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the accumulator policy
      effect: read
      questions:
      - What rules govern the cryptographic accumulators?
      - Where is the accumulator anchoring policy published?
      instructions:
      - text: Show the accumulator policy.
      - text: Get the rules for anchoring into accumulators.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accumulator/anchor'].post
  update:
    x-apievangelist-phrasing:
      intent: Anchor a key into an accumulator
      effect: write
      questions:
      - How do I add a key and value to an accumulator domain?
      - Can I attach a note to an anchored entry?
      instructions:
      - text: Anchor key {key} in domain {domain} as {anchored_by}.
        slots:
          key: requestBody.key
          domain: requestBody.domain
          anchored_by: requestBody.anchored_by
      - text: Add {key} with value {value} to accumulator {domain}, anchored by {anchored_by}.
        slots:
          key: requestBody.key
          value: requestBody.value
          domain: requestBody.domain
          anchored_by: requestBody.anchored_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accumulator/{domain}/root'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an accumulator's current root
      effect: read
      questions:
      - What is the current root of an accumulator domain?
      - Can I fetch the latest commitment for a domain?
      instructions:
      - text: Get the root of accumulator {domain}.
        slots:
          domain: path.domain
      - text: Show the current commitment for domain {domain}.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accumulator/{domain}/leaves'].get
  update:
    x-apievangelist-phrasing:
      intent: List an accumulator's leaves
      effect: read
      questions:
      - Which entries have been anchored into a domain?
      - Can I page through the leaves of an accumulator?
      instructions:
      - text: List leaves in accumulator {domain}.
        slots:
          domain: path.domain
      - text: Show {limit} leaves of {domain} starting at {offset}.
        slots:
          limit: query.limit
          domain: path.domain
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accumulator/{domain}/replay'].get
  update:
    x-apievangelist-phrasing:
      intent: Replay an accumulator's history
      effect: read
      questions:
      - Can I replay a domain's accumulator from the start to confirm its root?
      - Is there a way to recompute an accumulator's history?
      instructions:
      - text: Replay accumulator {domain}.
        slots:
          domain: path.domain
      - text: Recompute the history of domain {domain}.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accumulator/{domain}/inclusion'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an inclusion witness for a key
      effect: read
      questions:
      - Can I get proof that a key is in an accumulator?
      - What witness shows a key is a member of a domain?
      instructions:
      - text: Get an inclusion witness for {key} in {domain}.
        slots:
          key: query.key
          domain: path.domain
      - text: Prove {key} is included in accumulator {domain}.
        slots:
          key: query.key
          domain: path.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accumulator/{domain}/non-membership'].get
  update:
    x-apievangelist-phrasing:
      intent: Prove a key is absent from an accumulator
      effect: read
      questions:
      - Can I prove a key has never been anchored in a domain?
      - Is there a non-membership proof for accumulators?
      instructions:
      - text: Prove {key} is not in accumulator {domain}.
        slots:
          key: query.key
          domain: path.domain
      - text: Get a non-membership proof for {key} in {domain}.
        slots:
          key: query.key
          domain: path.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accumulator/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify an accumulator inclusion witness
      effect: read
      questions:
      - Is an inclusion witness I was given actually valid?
      - Can I check a witness returned by the inclusion endpoint?
      instructions:
      - text: Verify inclusion witness {witness}.
        slots:
          witness: requestBody.witness
      - text: Check that witness {witness} holds against its accumulator.
        slots:
          witness: requestBody.witness
      method: generated
      generated: '2026-09-26'