Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com R8 Checkpoints API

8 actions 8 updates phrasing extends openapi/thehiveryiq-com-r8-checkpoints-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 8

$.info
$.paths['/v1/checkpoint/policy'].get
$.paths['/v1/checkpoint/write'].post
$.paths['/v1/checkpoint/list'].get
$.paths['/v1/checkpoint/workflow/{wid}'].get
$.paths['/v1/checkpoint/archive/{wid}'].post
$.paths['/v1/checkpoint/replay/{wid}'].get
$.paths['/v1/checkpoint/{cid}'].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 R8 Checkpoints API
  version: 1.0.0
extends: openapi/thehiveryiq-com-r8-checkpoints-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: 7
- target: $.paths['/v1/checkpoint/policy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the workflow checkpoint policy
      effect: read
      questions:
      - What rules apply to agent workflow checkpoints?
      - Where is the checkpoint policy?
      instructions:
      - text: Show the checkpoint policy.
      - text: Get the rules for writing workflow checkpoints.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checkpoint/write'].post
  update:
    x-apievangelist-phrasing:
      intent: Write an agent workflow checkpoint
      effect: write
      questions:
      - How do I save a checkpoint for an agent at a given workflow phase?
      - Can a checkpoint reference receipts, artifacts and a delegation?
      instructions:
      - text: Write a {phase} checkpoint for agent {agent_did} under operator {operator_did}.
        slots:
          phase: requestBody.phase
          agent_did: requestBody.agent_did
          operator_did: requestBody.operator_did
      - text: Checkpoint workflow {wid} at phase {phase} for {agent_did} run by {operator_did} with state {state}.
        slots:
          wid: requestBody.wid
          phase: requestBody.phase
          agent_did: requestBody.agent_did
          operator_did: requestBody.operator_did
          state: requestBody.state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checkpoint/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflow checkpoints
      effect: read
      questions:
      - Which checkpoints exist for an agent or workflow?
      - Can I filter checkpoints by phase?
      instructions:
      - text: List checkpoints for agent {agent_did}.
        slots:
          agent_did: query.agent_did
      - text: Show {limit} checkpoints in phase {phase} for workflow {wid}.
        slots:
          limit: query.limit
          phase: query.phase
          wid: query.wid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checkpoint/workflow/{wid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow's checkpoints
      effect: read
      questions:
      - What is the current checkpoint state of a workflow?
      - Can I pull everything recorded for one workflow id?
      instructions:
      - text: Get workflow {wid} checkpoints.
        slots:
          wid: path.wid
      - text: Show the checkpoint record for workflow {wid}.
        slots:
          wid: path.wid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checkpoint/archive/{wid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a workflow's checkpoints
      effect: write
      questions:
      - Can I archive a finished workflow's checkpoints?
      - What happens to a workflow once it is archived?
      instructions:
      - text: Archive workflow {wid}.
        slots:
          wid: path.wid
      - text: Close out and archive checkpoints for {wid}.
        slots:
          wid: path.wid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checkpoint/replay/{wid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Replay a workflow from its checkpoints
      effect: read
      questions:
      - Can I replay a workflow's checkpoints in order?
      - Is there a way to reconstruct how a workflow progressed?
      instructions:
      - text: Replay workflow {wid}.
        slots:
          wid: path.wid
      - text: Reconstruct the phase sequence of {wid}.
        slots:
          wid: path.wid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checkpoint/{cid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single checkpoint
      effect: read
      questions:
      - Can I fetch one checkpoint by its checkpoint id?
      - What was recorded in a specific checkpoint?
      instructions:
      - text: Get checkpoint {cid}.
        slots:
          cid: path.cid
      - text: Show the contents of checkpoint {cid}.
        slots:
          cid: path.cid
      method: generated
      generated: '2026-09-26'