Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Compound Chains API

6 actions 6 updates phrasing extends openapi/thehiveryiq-com-compound-chains-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/compound/chain'].post
$.paths['/v1/compound/chains'].get
$.paths['/v1/compound/chain/{name_or_id}'].get
$.paths['/v1/compound/chain/{name_or_id}/run'].post
$.paths['/v1/compound/runs'].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 Compound Chains API
  version: 1.0.0
extends: openapi/thehiveryiq-com-compound-chains-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/compound/chain'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a compound chain template
      effect: write
      questions:
      - How do I wire several affordance verbs into a reusable chain?
      - Can a later step reference an earlier step's receipt hash?
      instructions:
      - text: Register chain template {name} with steps {steps}.
        slots:
          name: requestBody.name
          steps: requestBody.steps
      - text: Create a chain called {name} described as {description} running {steps}.
        slots:
          name: requestBody.name
          description: requestBody.description
          steps: requestBody.steps
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/compound/chains'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered chain templates
      effect: read
      questions:
      - Which chain templates have been registered?
      - What compound chains are available to run?
      instructions:
      - text: List all chain templates.
      - text: Show the first {limit} registered chains.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/compound/chain/{name_or_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chain template's steps
      effect: read
      questions:
      - What steps make up a particular chain template?
      - How do I look up a chain by its name or ID?
      instructions:
      - text: Get chain template {name_or_id}.
        slots:
          name_or_id: path.name_or_id
      - text: Show the steps defined in chain {name_or_id}.
        slots:
          name_or_id: path.name_or_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/compound/chain/{name_or_id}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a chain template
      effect: write
      questions:
      - How do I execute every step of a chain in order?
      - Can I override parameters for individual steps when running a chain?
      instructions:
      - text: Run chain {name_or_id}.
        slots:
          name_or_id: path.name_or_id
      - text: Run chain {name_or_id} with step overrides {override_params}.
        slots:
          name_or_id: path.name_or_id
          override_params: requestBody.override_params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/compound/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent chain runs
      effect: read
      questions:
      - What chain runs happened recently and did they succeed?
      - Can I see run history for just one chain template?
      instructions:
      - text: List recent runs of chain {template_name}.
        slots:
          template_name: query.template_name
      - text: Show the last {limit} chain runs.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'