Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Runrate API

5 actions 5 updates phrasing extends openapi/thehiveryiq-com-runrate-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/runrate/tick'].post

$.paths['/v1/runrate/status'].get

$.paths['/v1/runrate/ledger'].get

$.paths['/v1/runrate/schedule'].get

OpenAPI Overlay

# 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 Runrate API
  version: 1.0.0
extends: openapi/thehiveryiq-com-runrate-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/runrate/tick'].post
  update:
    x-apievangelist-phrasing:
      intent: Run one run-rate orchestrator tick
      effect: write
      questions:
      - How do I manually fire the run-rate drivers that are due?
      - Can I force specific drivers to run even if they aren't scheduled?
      instructions:
      - text: Run one run-rate orchestrator tick.
      - text: Tick the orchestrator, forcing drivers {force_drivers} against {base_url}.
        slots:
          force_drivers: query.force_drivers
          base_url: query.base_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/runrate/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current run-rate snapshot
      effect: read
      questions:
      - What is the current revenue run rate?
      - Can I see the run-rate snapshot without triggering any drivers?
      instructions:
      - text: Show the current run-rate status.
      - text: Get the run-rate snapshot without firing drivers.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/runrate/ledger'].get
  update:
    x-apievangelist-phrasing:
      intent: Read recent run-rate ledger entries
      effect: read
      questions:
      - What has the run-rate ledger recorded recently?
      - How many ledger entries can I pull at once?
      instructions:
      - text: Show the run-rate ledger.
      - text: Get the last {n} run-rate ledger entries.
        slots:
          n: query.n
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/runrate/schedule'].get
  update:
    x-apievangelist-phrasing:
      intent: See the run-rate driver schedule
      effect: read
      questions:
      - When did each run-rate driver last run and when is it next due?
      - What cadence are the run-rate drivers on?
      instructions:
      - text: Show the run-rate driver schedule.
      - text: List each driver's cadence, last run and next due time.
      method: generated
      generated: '2026-09-26'