Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Hive Origin API

6 actions 6 updates phrasing extends openapi/thehiveryiq-com-hive-origin-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/origin/create'].post
$.paths['/v1/origin/by-hash/{work_hash}'].get
$.paths['/v1/origin/by-creator/{did}'].get
$.paths['/v1/origin/git-integration'].post
$.paths['/v1/origin/health'].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 Hive Origin API
  version: 1.0.0
extends: openapi/thehiveryiq-com-hive-origin-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/origin/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Stamp a work as an origin copyright record
      effect: write
      questions:
      - How do I prove I created a work first by stamping its hash?
      - Can I record a license such as cc-by-4.0 when stamping a work?
      instructions:
      - text: Stamp work hash {work_hash} for creator {creator_did}.
        slots:
          work_hash: requestBody.work_hash
          creator_did: requestBody.creator_did
      - text: Register {title} with hash {work_hash} by {creator_did} under license {license}.
        slots:
          title: requestBody.title
          work_hash: requestBody.work_hash
          creator_did: requestBody.creator_did
          license: requestBody.license
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/origin/by-hash/{work_hash}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find who stamped a work hash first
      effect: read
      questions:
      - Who is the earliest creator on record for a given work hash?
      - Has anyone else already stamped this work's hash?
      instructions:
      - text: Show the origin records for work hash {work_hash}.
        slots:
          work_hash: path.work_hash
      - text: Who first stamped {work_hash}.
        slots:
          work_hash: path.work_hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/origin/by-creator/{did}'].get
  update:
    x-apievangelist-phrasing:
      intent: List works stamped by a creator
      effect: read
      questions:
      - Which works has a creator DID stamped as origin records?
      - Can I page through a creator's registered works 50 at a time?
      instructions:
      - text: List works stamped by creator {did}.
        slots:
          did: path.did
      - text: Show {limit} works by {did} starting at offset {offset}.
        slots:
          limit: query.limit
          did: path.did
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/origin/git-integration'].post
  update:
    x-apievangelist-phrasing:
      intent: Stamp a git commit as a creation event
      effect: write
      questions:
      - How do I get a copyright receipt for each git commit I push?
      - Can I stamp a commit SHA without sending the commit message itself?
      instructions:
      - text: Stamp commit {commit_sha} in {repo_url} for {creator_did} with message hash {commit_message_hash}.
        slots:
          commit_sha: requestBody.commit_sha
          repo_url: requestBody.repo_url
          creator_did: requestBody.creator_did
          commit_message_hash: requestBody.commit_message_hash
      - text: Record git commit {commit_sha} from repo {repo_url} as a creation by {creator_did}, message hash {commit_message_hash}.
        slots:
          commit_sha: requestBody.commit_sha
          repo_url: requestBody.repo_url
          creator_did: requestBody.creator_did
          commit_message_hash: requestBody.commit_message_hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/origin/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check origin service health and counts
      effect: read
      questions:
      - Is the origin copyright stamping service healthy?
      - How many origin records has the service stored?
      instructions:
      - text: Check origin service health.
      - text: Show origin record counts.
      method: generated
      generated: '2026-09-26'