Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Purity API

4 actions 4 updates phrasing extends openapi/thehiveryiq-com-purity-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/purity/health'].get
$.paths['/v1/purity/cert/issue'].post
$.paths['/v1/purity/cert/{cert_id}'].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 Purity API
  version: 1.0.0
extends: openapi/thehiveryiq-com-purity-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/purity/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the purity certificate service
      effect: read
      questions:
      - Is the purity certification service up?
      - Can I check purity service health before issuing certs?
      instructions:
      - text: Check purity service health.
      - text: Tell me if purity certs are available.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/purity/cert/issue'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a purity certificate
      effect: write
      questions:
      - How do I issue a purity certificate for a product?
      - Can a purity cert include FSMA 204 traceability data?
      instructions:
      - text: Issue a purity cert from {issuer_did} for {subject} on {substrate} with axes {axes}.
        slots:
          issuer_did: requestBody.issuer_did
          subject: requestBody.subject
          substrate: requestBody.substrate
          axes: requestBody.axes
      - text: Certify {subject} ({substrate}) with axes {axes} and FSMA 204 data {fsma_204}, issuer {issuer_did}.
        slots:
          subject: requestBody.subject
          substrate: requestBody.substrate
          axes: requestBody.axes
          fsma_204: requestBody.fsma_204
          issuer_did: requestBody.issuer_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/purity/cert/{cert_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a purity certificate
      effect: read
      questions:
      - What does an issued purity certificate say?
      - Can I look up a purity cert by ID?
      instructions:
      - text: Show purity cert {cert_id}.
        slots:
          cert_id: path.cert_id
      - text: Get certificate {cert_id}.
        slots:
          cert_id: path.cert_id
      method: generated
      generated: '2026-09-26'