Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Protected Flow API

4 actions 4 updates phrasing extends openapi/thehiveryiq-com-protected-flow-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 4

$.info

$.paths['/v1/protected-flow/health'].get

$.paths['/v1/protected-flow/assess'].post

$.paths['/v1/protected-flow/evidence/{group_id}/export'].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 Protected Flow API
  version: 1.0.0
extends: openapi/thehiveryiq-com-protected-flow-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: 3
- target: $.paths['/v1/protected-flow/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Discover Protected Flow capabilities
      effect: read
      questions:
      - Which decision classes and policy packs does Protected Flow support?
      - How do I find the Protected Flow version, meter and signer?
      instructions:
      - text: Show Protected Flow discovery info.
      - text: List Protected Flow's policy packs and decision classes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/protected-flow/assess'].post
  update:
    x-apievangelist-phrasing:
      intent: Assess a receipt group and get a signed decision
      effect: write
      questions:
      - How do I get a signed risk decision and meter quote for a group of payment receipts?
      - Can I assess receipts inline without creating a group first?
      - Can I apply a stricter policy pack like strict_bank to an assessment?
      instructions:
      - text: Assess receipt group {group_id}.
        slots:
          group_id: requestBody.group_id
      - text: Assess group {group_id} under policy pack {policy_pack} with {declared_exposure_usd} USD exposure, and persist it.
        slots:
          group_id: requestBody.group_id
          policy_pack: requestBody.policy_pack
          declared_exposure_usd: requestBody.declared_exposure_usd
      - text: Assess receipts {receipt_ids} as an ad-hoc group labelled {label}.
        slots:
          receipt_ids: requestBody.receipt_ids
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/protected-flow/evidence/{group_id}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export the evidence bundle for a receipt group
      effect: read
      questions:
      - How do I export the signed evidence for an assessed receipt group?
      - Does the evidence bundle include the public key to check signatures?
      instructions:
      - text: Export the evidence bundle for group {group_id}.
        slots:
          group_id: path.group_id
      - text: Download the signed assessment and receipts for {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'