Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com R5 Hktn Reputation API

6 actions 6 updates phrasing extends openapi/thehiveryiq-com-r5-hktn-reputation-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/hktn/rep/policy'].get

$.paths['/v1/hktn/rep/leaderboard'].get

$.paths['/v1/hktn/rep/event'].post

$.paths['/v1/hktn/rep/preview'].post

$.paths['/v1/hktn/rep/{agent_did}'].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 R5 Hktn Reputation API
  version: 1.0.0
extends: openapi/thehiveryiq-com-r5-hktn-reputation-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/hktn/rep/policy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the HKTN reputation policy
      effect: read
      questions:
      - How is an agent's HKTN reputation calculated?
      - Which event types affect reputation scores?
      instructions:
      - text: Show the HKTN reputation policy.
      - text: Get the scoring rules for agent reputation.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hktn/rep/leaderboard'].get
  update:
    x-apievangelist-phrasing:
      intent: Rank agents by reputation
      effect: read
      questions:
      - Which agents have the highest HKTN reputation?
      - Can I limit the reputation leaderboard to the top few agents?
      instructions:
      - text: Show the reputation leaderboard.
      - text: List the top {limit} agents by reputation.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hktn/rep/event'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a reputation event for an agent
      effect: write
      questions:
      - How do I log something an agent did so it counts toward its reputation?
      - Can I attach context to a reputation event?
      instructions:
      - text: Record a {event_type} reputation event for {agent_did}.
        slots:
          event_type: requestBody.event_type
          agent_did: requestBody.agent_did
      - text: Log {event_type} for agent {agent_did} with context {context}.
        slots:
          event_type: requestBody.event_type
          agent_did: requestBody.agent_did
          context: requestBody.context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hktn/rep/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview reputation after hypothetical events
      effect: read
      questions:
      - What would an agent's reputation become if certain events happened?
      - Can I simulate reputation changes without recording anything?
      instructions:
      - text: Preview reputation for {agent_did} with events {hypothetical_events}.
        slots:
          agent_did: requestBody.agent_did
          hypothetical_events: requestBody.hypothetical_events
      - text: Simulate the reputation of {agent_did}.
        slots:
          agent_did: requestBody.agent_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hktn/rep/{agent_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent's reputation
      effect: read
      questions:
      - What is an agent's current HKTN reputation tier?
      - Can I see the event history behind an agent's reputation?
      instructions:
      - text: Get the reputation of {agent_did}.
        slots:
          agent_did: path.agent_did
      - text: Show reputation for {agent_did} including history {history}.
        slots:
          agent_did: path.agent_did
          history: query.history
      method: generated
      generated: '2026-09-26'