Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Hive Mark API

6 actions 6 updates phrasing extends openapi/thehiveryiq-com-hive-mark-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/mark/attest'].post
$.paths['/v1/mark/by-text/{mark_text}'].get
$.paths['/v1/mark/by-owner/{did}'].get
$.paths['/v1/mark/monitor'].post
$.paths['/v1/mark/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 Mark API
  version: 1.0.0
extends: openapi/thehiveryiq-com-hive-mark-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/mark/attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest first use of a trademark
      effect: write
      questions:
      - How do I create a signed record proving when my brand first used a trademark?
      - Can I attach the URL and a screenshot hash as evidence of first use?
      instructions:
      - text: Attest first use of the mark {mark_text} for owner {brand_owner_did}.
        slots:
          mark_text: requestBody.mark_text
          brand_owner_did: requestBody.brand_owner_did
      - text: Record {brand_owner_did}'s first use of {mark_text} at {use_url} with evidence hash {evidence_hash}.
        slots:
          brand_owner_did: requestBody.brand_owner_did
          mark_text: requestBody.mark_text
          use_url: requestBody.use_url
          evidence_hash: requestBody.evidence_hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mark/by-text/{mark_text}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find attestations for a trademark string
      effect: read
      questions:
      - Who attested a given trademark first?
      - Can I see every first-use attestation for an exact mark, earliest first?
      instructions:
      - text: List all attestations for the mark {mark_text}.
        slots:
          mark_text: path.mark_text
      - text: Find who has priority on trademark {mark_text}.
        slots:
          mark_text: path.mark_text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mark/by-owner/{did}'].get
  update:
    x-apievangelist-phrasing:
      intent: List marks attested by an owner
      effect: read
      questions:
      - Which trademarks has a particular brand owner attested?
      - How do I see all marks tied to one owner DID?
      instructions:
      - text: List marks attested by owner {did}.
        slots:
          did: path.did
      - text: Show every trademark attestation from {did}.
        slots:
          did: path.did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mark/monitor'].post
  update:
    x-apievangelist-phrasing:
      intent: Start monitoring a brand mark
      effect: write
      questions:
      - Can I set up ongoing monitoring for my trademark across specific domains?
      - What does the $50/month brand monitoring tier record?
      instructions:
      - text: Monitor the mark {mark_text} for owner {brand_owner_did}.
        slots:
          mark_text: requestBody.mark_text
          brand_owner_did: requestBody.brand_owner_did
      - text: Watch {watch_domains} for uses of {mark_text} on behalf of {brand_owner_did}.
        slots:
          watch_domains: requestBody.watch_domains
          mark_text: requestBody.mark_text
          brand_owner_did: requestBody.brand_owner_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mark/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check trademark service health and counts
      effect: read
      questions:
      - Is the trademark attestation service up?
      - How many mark attestations and monitors exist so far?
      instructions:
      - text: Check Hive Mark health.
      - text: Show the trademark service's attestation and monitor counts.
      method: generated
      generated: '2026-09-26'