Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Mining Orchestrate API

7 actions 7 updates phrasing extends openapi/thehiveryiq-com-mining-orchestrate-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 7

$.info
$.paths['/v1/mining/orchestrate/health'].get
$.paths['/v1/mining/orchestrate/register'].post
$.paths['/v1/mining/orchestrate/sites/sync'].post
$.paths['/v1/mining/orchestrate/sites'].get
$.paths['/v1/mining/orchestrate/payouts'].get
$.paths['/v1/mining/orchestrate/payouts/withdraw'].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 Mining Orchestrate API
  version: 1.0.0
extends: openapi/thehiveryiq-com-mining-orchestrate-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: 6
- target: $.paths['/v1/mining/orchestrate/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the mining orchestration layer
      effect: read
      questions:
      - What capabilities and version does the MOS orchestration layer report?
      - Is the mining orchestration service healthy?
      instructions:
      - text: Check mining orchestration health.
      - text: Show the MOS orchestration layer's capabilities and version.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mining/orchestrate/register'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a mining operator's MOS instance
      effect: write
      questions:
      - How do I register my MOS instance as a mining operator?
      - Can I re-register my operator to update the endpoint or sites?
      instructions:
      - text: Register operator {operator_did} with MOS endpoint {mos_endpoint} and wallet {wallet_addr}.
        slots:
          operator_did: requestBody.operator_did
          mos_endpoint: requestBody.mos_endpoint
          wallet_addr: requestBody.wallet_addr
      - text: Register MOS operator {operator_did} at {mos_endpoint} paying to {wallet_addr} with sites {sites}.
        slots:
          operator_did: requestBody.operator_did
          mos_endpoint: requestBody.mos_endpoint
          wallet_addr: requestBody.wallet_addr
          sites: requestBody.sites
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mining/orchestrate/sites/sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Push a site telemetry batch
      effect: write
      questions:
      - How does an operator push worker telemetry for a mining site?
      - Is it safe to resend the same telemetry batch twice?
      instructions:
      - text: Sync site {site_id} for operator {operator_did} with batch timestamp {batch_ts}.
        slots:
          site_id: requestBody.site_id
          operator_did: requestBody.operator_did
          batch_ts: requestBody.batch_ts
      - text: Push telemetry {telemetry} for site {site_id} from {operator_did} at {batch_ts}.
        slots:
          telemetry: requestBody.telemetry
          site_id: requestBody.site_id
          operator_did: requestBody.operator_did
          batch_ts: requestBody.batch_ts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mining/orchestrate/sites'].get
  update:
    x-apievangelist-phrasing:
      intent: List an operator's mining sites
      effect: read
      questions:
      - Which sites has a mining operator registered and what is their latest telemetry?
      - Where can I see my mining sites' most recent readings?
      instructions:
      - text: List the sites for operator {operator_did}.
        slots:
          operator_did: query.operator_did
      - text: Show latest site telemetry for {operator_did}.
        slots:
          operator_did: query.operator_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mining/orchestrate/payouts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an operator's pending USDC payout
      effect: read
      questions:
      - How much USDC is waiting to be paid out to a mining operator?
      - What is my pending payout balance on the earn rails ledger?
      instructions:
      - text: Show pending payouts for operator {operator_did}.
        slots:
          operator_did: query.operator_did
      - text: Get the USDC payout balance owed to {operator_did}.
        slots:
          operator_did: query.operator_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mining/orchestrate/payouts/withdraw'].post
  update:
    x-apievangelist-phrasing:
      intent: Withdraw an operator's mining payout
      effect: write
      questions:
      - How does a mining operator withdraw their pending USDC balance?
      - Is a payout withdrawal broadcast right away or only constructed?
      instructions:
      - text: Withdraw {amount_usdc} USDC for operator {operator_did}.
        slots:
          amount_usdc: requestBody.amount_usdc
          operator_did: requestBody.operator_did
      - text: Construct a {amount_usdc} USDC payout withdrawal for {operator_did}.
        slots:
          amount_usdc: requestBody.amount_usdc
          operator_did: requestBody.operator_did
      method: generated
      generated: '2026-09-26'