Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Mos Intel API

6 actions 6 updates phrasing extends openapi/thehiveryiq-com-mos-intel-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/mos/intel/register'].post
$.paths['/v1/mos/intel/telemetry'].post
$.paths['/v1/mos/intel/recommendations/{site_did}'].get
$.paths['/v1/mos/intel/sites'].get
$.paths['/v1/mos/intel/attest/{site_did}'].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 Mos Intel API
  version: 1.0.0
extends: openapi/thehiveryiq-com-mos-intel-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/mos/intel/register'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a mining site
      effect: write
      questions:
      - How do I register my mining site to get optimization recommendations?
      - What happens if I register the same site DID twice?
      - How is the mining intel subscription priced?
      instructions:
      - text: Register mining site {site_did}.
        slots:
          site_did: requestBody.site_did
      - text: Register site {site_did} for operator {operator_name} with {machine_count} machines.
        slots:
          site_did: requestBody.site_did
          operator_name: requestBody.operator_name
          machine_count: requestBody.machine_count
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mos/intel/telemetry'].post
  update:
    x-apievangelist-phrasing:
      intent: Push signed telemetry from a mining site
      effect: write
      questions:
      - How do I send hashrate and temperature telemetry from my site?
      - Is submitted mining telemetry kept in an auditable log?
      instructions:
      - text: Push telemetry for site {site_did}.
        slots:
          site_did: requestBody.site_did
      - text: Submit signed telemetry {payload} from site {site_did}.
        slots:
          payload: requestBody.payload
          site_did: requestBody.site_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mos/intel/recommendations/{site_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get optimization recommendations for a site
      effect: read
      questions:
      - What throttle or pool routing changes are suggested for my mining site?
      - Does the service apply recommendations automatically or just suggest them?
      instructions:
      - text: Get recommendations for mining site {site_did}.
        slots:
          site_did: path.site_did
      - text: Show throttle suggestions for {site_did}.
        slots:
          site_did: path.site_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mos/intel/sites'].get
  update:
    x-apievangelist-phrasing:
      intent: List all registered mining sites (admin)
      effect: read
      questions:
      - How can an admin see every registered mining site?
      - Which mining sites are signed up, for billing and capacity planning?
      instructions:
      - text: List all registered mining sites.
      - text: Show the admin roster of mining sites.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mos/intel/attest/{site_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: Request a ZK attestation for a site
      effect: read
      questions:
      - Can I get a zero-knowledge attestation for my mining site yet?
      - Why does the site attestation endpoint return 501?
      instructions:
      - text: Request a ZK attestation for site {site_did}.
        slots:
          site_did: path.site_did
      - text: Check whether an attestation is available for {site_did}.
        slots:
          site_did: path.site_did
      method: generated
      generated: '2026-09-26'