Hive Civilization · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Thehiveryiq Com Hivecomply API
9 actions
9 updates
phrasing
extends
openapi/thehiveryiq-com-hivecomply-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.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/v1/hivecomply/health'].get
$.paths['/v1/hivecomply/pricing'].get
$.paths['/v1/hivecomply/framework/map'].get
$.paths['/v1/hivecomply/control/status'].get
$.paths['/v1/hivecomply/event/ingest'].post
$.paths['/v1/hivecomply/evidence/query'].post
$.paths['/v1/hivecomply/bundle/export'].post
$.paths['/v1/hivecomply/bundle/verify'].post
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 Hivecomply API
version: 1.0.0
extends: openapi/thehiveryiq-com-hivecomply-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: 8
- target: $.paths['/v1/hivecomply/health'].get
update:
x-apievangelist-phrasing:
intent: Check HiveComply service health
effect: read
questions:
- Is the HiveComply evidence service running?
- How do I health-check the compliance evidence API?
instructions:
- text: Check HiveComply health.
- text: Ping the compliance evidence service.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/hivecomply/pricing'].get
update:
x-apievangelist-phrasing:
intent: Get HiveComply pricing
effect: read
questions:
- What does it cost to ingest compliance events and export evidence bundles?
- Where are the prices for HiveComply?
instructions:
- text: Show HiveComply pricing.
- text: List the cost of event ingest and bundle export.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/hivecomply/framework/map'].get
update:
x-apievangelist-phrasing:
intent: List supported frameworks and their controls
effect: read
questions:
- Which compliance frameworks and controls does HiveComply map?
- What controls are included for SOC 2 or ISO 27001?
instructions:
- text: Show all framework profiles and their controls.
- text: List the 11 supported frameworks with control codes.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/hivecomply/control/status'].get
update:
x-apievangelist-phrasing:
intent: Check evidence status for a control
effect: read
questions:
- How many events have been recorded against a specific control, and when was the last one?
- Is control CC6.1 getting fresh evidence?
instructions:
- text: Show event count and last event time for {framework} control {control}.
slots:
framework: query.framework
control: query.control
- text: Check the evidence status of control {control} under {framework}.
slots:
control: query.control
framework: query.framework
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/hivecomply/event/ingest'].post
update:
x-apievangelist-phrasing:
intent: Ingest a compliance event and get a receipt
effect: write
questions:
- How do I log an access or config-change event as compliance evidence?
- Can one event count toward controls in several frameworks at once?
instructions:
- text: Ingest a {event_type} event by {actor_did} for frameworks {framework_codes} controls {control_codes} with evidence hash {evidence_hash}.
slots:
event_type: requestBody.event_type
actor_did: requestBody.actor_did
framework_codes: requestBody.framework_codes
control_codes: requestBody.control_codes
evidence_hash: requestBody.evidence_hash
- text: Record {event_type} by {actor_did} on {subject_did} as evidence for {framework_codes} {control_codes}, hash {evidence_hash}.
slots:
event_type: requestBody.event_type
actor_did: requestBody.actor_did
subject_did: requestBody.subject_did
framework_codes: requestBody.framework_codes
control_codes: requestBody.control_codes
evidence_hash: requestBody.evidence_hash
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/hivecomply/evidence/query'].post
update:
x-apievangelist-phrasing:
intent: Search compliance events by framework and period
effect: read
questions:
- Which compliance events were recorded for SOC 2 last quarter?
- Can I filter evidence by control and a start and end date?
instructions:
- text: Query compliance events for {framework} control {control}.
slots:
framework: requestBody.framework
control: requestBody.control
- text: Find {framework} events between {period_start} and {period_end}.
slots:
framework: requestBody.framework
period_start: requestBody.period_start
period_end: requestBody.period_end
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/hivecomply/bundle/export'].post
update:
x-apievangelist-phrasing:
intent: Export a signed evidence bundle for auditors
effect: write
questions:
- How do I package compliance evidence into a signed bundle for an auditor?
- Can I export an evidence bundle scoped to one control and period?
instructions:
- text: Export a signed evidence bundle for {framework} from {period_start} to {period_end}.
slots:
framework: requestBody.framework
period_start: requestBody.period_start
period_end: requestBody.period_end
- text: Build an auditor bundle for control {control} under {framework}.
slots:
control: requestBody.control
framework: requestBody.framework
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/hivecomply/bundle/verify'].post
update:
x-apievangelist-phrasing:
intent: Verify an exported evidence bundle
effect: read
questions:
- How can an auditor confirm an evidence bundle's hash and dual signatures?
- Is this exported bundle still intact?
instructions:
- text: Verify bundle {bundle_id} offline using its Ed25519 signature {ed25519_signature} and ML-DSA-65 signature {mldsa65_signature}.
slots:
bundle_id: requestBody.bundle_id
ed25519_signature: requestBody.ed25519_signature
mldsa65_signature: requestBody.mldsa65_signature
- text: Check that bundle {bundle_id} matches hash {bundle_hash}.
slots:
bundle_id: requestBody.bundle_id
bundle_hash: requestBody.bundle_hash
method: generated
generated: '2026-09-26'