Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Portal API

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

$.info
$.paths['/v1/portal/{tenant_id}/kpi'].get
$.paths['/v1/portal/{tenant_id}/balance'].get
$.paths['/v1/portal/{tenant_id}/api-key/rotate'].post
$.paths['/v1/portal/{tenant_id}/api-key/revoke'].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 Portal API
  version: 1.0.0
extends: openapi/thehiveryiq-com-portal-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: 4
- target: $.paths['/v1/portal/{tenant_id}/kpi'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant's KPI snapshot
      effect: read
      questions:
      - What are the headline KPIs for my tenant?
      - Is the tenant KPI data real or synthetic?
      instructions:
      - text: Show the KPI snapshot for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Get key metrics for {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/portal/{tenant_id}/balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant's balance and billing state
      effect: read
      questions:
      - What's my tenant's on-chain balance and billing status?
      - Am I behind on billing for my portal account?
      instructions:
      - text: Show the balance for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Check billing state and on-chain balance of {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/portal/{tenant_id}/api-key/rotate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a tenant's API key
      effect: write
      questions:
      - How do I rotate my API key without breaking in-flight requests?
      - How long does the old key keep working after a rotation?
      instructions:
      - text: Rotate the API key for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Issue a new API key for {tenant_id} with the usual grace window.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/portal/{tenant_id}/api-key/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a tenant's API keys immediately
      effect: destructive
      questions:
      - How do I kill all active API keys for my tenant right now?
      - Can I revoke just one leaked key instead of all of them?
      instructions:
      - text: Revoke all API keys for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Immediately disable every active key on {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'