Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Bounty API

15 actions 15 updates phrasing extends openapi/thehiveryiq-com-bounty-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 15

$.info
$.paths['/v1/bounty/program'].get
$.paths['/v1/bounty/register'].post
$.paths['/v1/bounty/leaderboard'].get
$.paths['/v1/bounty/status/{code}'].get
$.paths['/v1/bounty/admin/confirm'].post
$.paths['/v1/bounty/admin/attribute'].post
$.paths['/v1/bounty/admin/payout'].post
$.paths['/v1/bounty/health'].get
$.paths['/v1/bounty/'].get
$.paths['/v1/bounty'].get
$.paths['/v1/bounty/status/'].get
$.paths['/v1/bounty/status'].get
$.paths['/v1/bounty/admin/queue'].get
$.paths['/v1/bounty/lookup'].post

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 Bounty API
  version: 1.0.0
extends: openapi/thehiveryiq-com-bounty-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: 14
- target: $.paths['/v1/bounty/program'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the bounty program terms
      effect: read
      questions:
      - What are the rules and rewards of the Hive bounty program?
      - How does the referral bounty program pay out?
      instructions:
      - text: Show me the bounty program details.
      - text: Get the current bounty program terms and rewards.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bounty/register'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a submission for the bounty
      effect: write
      questions:
      - How do I sign up my repo for the bounty program?
      - Which framework and verify URL do I have to give when registering for the bounty?
      - Can I add a wallet to receive bounty payouts when I register?
      instructions:
      - text: Register {handle} for the bounty with repo {repo_url}, verify URL {verify_url} and framework {framework}.
        slots:
          handle: requestBody.handle
          repo_url: requestBody.repo_url
          verify_url: requestBody.verify_url
          framework: requestBody.framework
      - text: Enter repo {repo_url} built on {framework} into the bounty as {handle}, verified at {verify_url}, paying out to wallet {wallet}.
        slots:
          repo_url: requestBody.repo_url
          framework: requestBody.framework
          handle: requestBody.handle
          verify_url: requestBody.verify_url
          wallet: requestBody.wallet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bounty/leaderboard'].get
  update:
    x-apievangelist-phrasing:
      intent: View the bounty leaderboard
      effect: read
      questions:
      - Who is leading the bounty program right now?
      - Where can I see the ranking of bounty participants?
      instructions:
      - text: Show me the bounty leaderboard.
      - text: List the top bounty participants.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bounty/status/{code}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bounty submission's status by code
      effect: read
      questions:
      - How do I check where my bounty submission stands using my referral code?
      - Has my bounty entry been confirmed or paid out yet?
      instructions:
      - text: Check the bounty status for code {code}.
        slots:
          code: path.code
      - text: Tell me whether bounty submission {code} has been confirmed or paid.
        slots:
          code: path.code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bounty/admin/confirm'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm a bounty submission (admin)
      effect: write
      questions:
      - As an admin, how do I approve a pending bounty submission?
      - Can I leave a note when confirming a referrer's bounty entry?
      instructions:
      - text: Confirm bounty submission {referrer_code}.
        slots:
          referrer_code: requestBody.referrer_code
      - text: Approve referrer {referrer_code} in the bounty queue with note {note}.
        slots:
          referrer_code: requestBody.referrer_code
          note: requestBody.note
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bounty/admin/attribute'].post
  update:
    x-apievangelist-phrasing:
      intent: Attribute receipt value to a referrer (admin)
      effect: write
      questions:
      - How do I credit a referrer with the USDC value of a receipt they drove?
      - Can an admin tie a specific receipt to a bounty referral code?
      instructions:
      - text: Attribute receipt {receipt_id} worth {value_usdc} USDC to referrer {referrer_code}.
        slots:
          receipt_id: requestBody.receipt_id
          value_usdc: requestBody.value_usdc
          referrer_code: requestBody.referrer_code
      - text: Credit {referrer_code} with {value_usdc} USDC for receipt {receipt_id}.
        slots:
          referrer_code: requestBody.referrer_code
          value_usdc: requestBody.value_usdc
          receipt_id: requestBody.receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bounty/admin/payout'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a bounty payout (admin)
      effect: write
      questions:
      - How do I log that a bounty was paid out on-chain?
      - What transaction details are needed to record a referrer's USDC payout?
      instructions:
      - text: Record a {kind} payout of {amount_usdc} USDC to {referrer_code} in transaction {tx_hash}.
        slots:
          kind: requestBody.kind
          amount_usdc: requestBody.amount_usdc
          referrer_code: requestBody.referrer_code
          tx_hash: requestBody.tx_hash
      - text: Mark referrer {referrer_code} as paid {amount_usdc} USDC ({kind}), tx {tx_hash}.
        slots:
          referrer_code: requestBody.referrer_code
          amount_usdc: requestBody.amount_usdc
          kind: requestBody.kind
          tx_hash: requestBody.tx_hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bounty/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the bounty service health
      effect: read
      questions:
      - Is the bounty service up?
      - Can I health-check the bounty API before submitting?
      instructions:
      - text: Check the health of the bounty service.
      - text: Ping the bounty API health endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bounty/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the bounty endpoint map (trailing slash)
      effect: read
      questions:
      - What does the bounty root with a trailing slash return?
      - Is there an endpoint map at /v1/bounty/ with the slash?
      instructions:
      - text: Fetch the bounty endpoint map from /v1/bounty/ with the trailing slash.
      - text: Call the slash-terminated bounty root to see its route list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bounty'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the bounty endpoint map
      effect: read
      questions:
      - Which endpoints does the bounty API offer?
      - What do I get if I call the bare bounty path with no slash?
      instructions:
      - text: Show me the map of bounty endpoints from bare /v1/bounty.
      - text: List the available bounty routes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bounty/status/'].get
  update:
    x-apievangelist-phrasing:
      intent: Status route hint when code is missing (slash)
      effect: read
      questions:
      - What happens if I call /v1/bounty/status/ with a trailing slash and no code?
      - Does the slash-ended status path tell me how to look up my code?
      instructions:
      - text: Call /v1/bounty/status/ with the trailing slash and no code to see the usage hint.
      - text: Get the help message from the slash-ended bounty status path.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bounty/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Status route hint when code is missing
      effect: read
      questions:
      - Why does checking bounty status without a code not return my entry?
      - What does the bounty status path say when no code is given?
      instructions:
      - text: Call bounty status with no code to see how it should be used.
      - text: Show the guidance returned by bare /v1/bounty/status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bounty/admin/queue'].get
  update:
    x-apievangelist-phrasing:
      intent: Review the bounty admin queue
      effect: read
      questions:
      - Which bounty submissions are waiting for admin review?
      - How do I see the pending bounty queue as an admin?
      instructions:
      - text: Show me the bounty admin queue.
      - text: List submissions awaiting bounty confirmation using token {authorization}.
        slots:
          authorization: header.authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bounty/lookup'].post
  update:
    x-apievangelist-phrasing:
      intent: Recover a lost bounty code by repo
      effect: read
      questions:
      - I lost my bounty code — can I get it back from my repo URL?
      - How do I find the referral code tied to a repo I registered?
      instructions:
      - text: Recover the bounty code for repo {repo_url}.
        slots:
          repo_url: requestBody.repo_url
      - text: Look up which bounty code was issued to {repo_url}.
        slots:
          repo_url: requestBody.repo_url
      method: generated
      generated: '2026-09-26'