Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com R10 Rvc API

9 actions 9 updates phrasing extends openapi/thehiveryiq-com-r10-rvc-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/rvc/policy'].get
$.paths['/v1/rvc/srs'].get
$.paths['/v1/rvc/commit'].post
$.paths['/v1/rvc/open'].post
$.paths['/v1/rvc/batch-open'].post
$.paths['/v1/rvc/verify'].post
$.paths['/v1/rvc/{commitment_id}'].get
$.paths['/v1/rvc/{commitment_id}/openings'].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 R10 Rvc API
  version: 1.0.0
extends: openapi/thehiveryiq-com-r10-rvc-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/rvc/policy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the rubric vector commitment policy
      effect: read
      questions:
      - What policy governs rubric vector commitments?
      - Which rules apply when committing a scoring vector?
      instructions:
      - text: Show me the RVC policy.
      - text: Get the rubric commitment policy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/rvc/srs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the commitment scheme's reference string
      effect: read
      questions:
      - Where is the structured reference string used for rubric commitments?
      - Can I download the SRS to check openings myself?
      instructions:
      - text: Get the RVC structured reference string.
      - text: Fetch the SRS parameters for rubric commitments.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/rvc/commit'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit to a rubric score vector
      effect: write
      questions:
      - How do I lock in a score vector against a rubric so it can't be changed later?
      - What do I need to record when an operator commits a score?
      instructions:
      - text: Commit vector {vector} under rubric {rubric_root} by {operator} at {scored_at}.
        slots:
          vector: requestBody.vector
          rubric_root: requestBody.rubric_root
          operator: requestBody.operator
          scored_at: requestBody.scored_at
      - text: Commit scores {vector} for rubric {rubric_root} version {rubric_version}, operator {operator}, scored {scored_at}.
        slots:
          vector: requestBody.vector
          rubric_root: requestBody.rubric_root
          rubric_version: requestBody.rubric_version
          operator: requestBody.operator
          scored_at: requestBody.scored_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/rvc/open'].post
  update:
    x-apievangelist-phrasing:
      intent: Open one position of a commitment
      effect: read
      questions:
      - Can I reveal a single score from a committed vector with a proof?
      - What does a Merkle opening for one position contain?
      instructions:
      - text: Open position {k} of commitment {commitment_id}.
        slots:
          k: requestBody.k
          commitment_id: requestBody.commitment_id
      - text: Reveal score {k} from commitment {commitment_id} with its proof.
        slots:
          k: requestBody.k
          commitment_id: requestBody.commitment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/rvc/batch-open'].post
  update:
    x-apievangelist-phrasing:
      intent: Open several commitment positions at once
      effect: read
      questions:
      - Can I get openings for many positions of a commitment in one call?
      - Does the batch opening return one proof or a list of openings?
      instructions:
      - text: Open positions {positions} of commitment {commitment_id}.
        slots:
          positions: requestBody.positions
          commitment_id: requestBody.commitment_id
      - text: Batch-reveal scores {positions} from {commitment_id}.
        slots:
          positions: requestBody.positions
          commitment_id: requestBody.commitment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/rvc/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a commitment opening
      effect: read
      questions:
      - How can I check an opening really matches the commitment?
      - What happens if the opening was made under a different rubric root?
      instructions:
      - text: Verify opening {opening} against commitment {commitment_id}.
        slots:
          opening: requestBody.opening
          commitment_id: requestBody.commitment_id
      - text: Check opening {opening} for {commitment_id} expects rubric {expected_rubric_root}.
        slots:
          opening: requestBody.opening
          commitment_id: requestBody.commitment_id
          expected_rubric_root: requestBody.expected_rubric_root
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/rvc/{commitment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a rubric commitment
      effect: read
      questions:
      - What's recorded for a commitment I already made?
      - Can I look up a rubric vector commitment by ID?
      instructions:
      - text: Show commitment {commitment_id}.
        slots:
          commitment_id: path.commitment_id
      - text: Get the record for rubric commitment {commitment_id}.
        slots:
          commitment_id: path.commitment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/rvc/{commitment_id}/openings'].get
  update:
    x-apievangelist-phrasing:
      intent: List openings issued for a commitment
      effect: read
      questions:
      - Which positions of a commitment have already been revealed?
      - Can I page through the openings of one commitment?
      instructions:
      - text: List openings for commitment {commitment_id}.
        slots:
          commitment_id: path.commitment_id
      - text: Show {limit} openings of {commitment_id} from offset {offset}.
        slots:
          limit: query.limit
          commitment_id: path.commitment_id
          offset: query.offset
      method: generated
      generated: '2026-09-26'