Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Xcalibur Verify API

8 actions 8 updates phrasing extends openapi/thehiveryiq-com-xcalibur-verify-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 8

$.info
$.paths['/v1/verify/status'].get
$.paths['/v1/verify/commitment/build'].post
$.paths['/v1/verify/commitment/{tenant_id}/current'].get
$.paths['/v1/verify/proof/generate'].post
$.paths['/v1/verify/proof/verify'].post
$.paths['/v1/verify/dispute'].post
$.paths['/v1/verify/demo/run'].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 Xcalibur Verify API
  version: 1.0.0
extends: openapi/thehiveryiq-com-xcalibur-verify-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: 7
- target: $.paths['/v1/verify/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check XCALIBUR Verify service status
      effect: read
      questions:
      - Is the XCALIBUR Verify proof service up?
      - Can I check the verification pipeline's status before generating proofs?
      instructions:
      - text: Check XCALIBUR Verify status.
      - text: Report whether the proof and commitment service is running.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/verify/commitment/build'].post
  update:
    x-apievangelist-phrasing:
      intent: Build a corpus commitment for a tenant
      effect: write
      questions:
      - How do I build a new Merkle commitment over a tenant's corpus?
      - What do I need to trigger a fresh commitment build?
      instructions:
      - text: Build a commitment for tenant {tenant_id}.
        slots:
          tenant_id: requestBody.tenant_id
      - text: Rebuild the corpus Merkle commitment for {tenant_id}.
        slots:
          tenant_id: requestBody.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/verify/commitment/{tenant_id}/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant's current commitment
      effect: read
      questions:
      - What is the current commitment root for a tenant?
      - Which commitment version is live for a tenant right now?
      instructions:
      - text: Show the current commitment for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Get {tenant_id}'s live commitment root.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/verify/proof/generate'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate an inclusion proof for a corpus entry
      effect: write
      questions:
      - How do I generate a proof that an entry is in a tenant's committed corpus?
      - Can I generate a proof against an older commitment version?
      instructions:
      - text: Generate a proof for entry {entry_id} in tenant {tenant_id}.
        slots:
          entry_id: requestBody.entry_id
          tenant_id: requestBody.tenant_id
      - text: Prove entry {entry_id} for {tenant_id} against commitment version {commitment_version}.
        slots:
          entry_id: requestBody.entry_id
          tenant_id: requestBody.tenant_id
          commitment_version: requestBody.commitment_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/verify/proof/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify an inclusion proof against a commitment
      effect: read
      questions:
      - How do I check that a proof matches a commitment?
      - Can a certificate be checked along with the proof?
      instructions:
      - text: Verify proof {proof} against commitment {commitment}.
        slots:
          proof: requestBody.proof
          commitment: requestBody.commitment
      - text: Check proof {proof}, commitment {commitment} and certificate {certificate} together.
        slots:
          proof: requestBody.proof
          commitment: requestBody.commitment
          certificate: requestBody.certificate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/verify/dispute'].post
  update:
    x-apievangelist-phrasing:
      intent: Dispute a verification certificate
      effect: write
      questions:
      - How do I file a dispute against a certificate I think is wrong?
      - What information does a certificate dispute need?
      instructions:
      - text: 'Dispute certificate {certificate_id} for tenant {tenant_id}: {claim}.'
        slots:
          certificate_id: requestBody.certificate_id
          tenant_id: requestBody.tenant_id
          claim: requestBody.claim
      - text: File a dispute on {certificate_id} claiming {claim}, tenant {tenant_id}.
        slots:
          certificate_id: requestBody.certificate_id
          claim: requestBody.claim
          tenant_id: requestBody.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/verify/demo/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run the end-to-end verification demo
      effect: write
      questions:
      - Can I try the whole proof-and-certificate pipeline on the seeded demo corpus?
      - What does the demo run return when I inject my own prompt text?
      instructions:
      - text: Run the verification demo.
      - text: Run the demo with my content {caller_content} and demo entry {entry_id}.
        slots:
          caller_content: requestBody.caller_content
          entry_id: requestBody.entry_id
      method: generated
      generated: '2026-09-26'