Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Marketplace Bus API

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

$.info

$.paths['/v1/bus/offer'].post

$.paths['/v1/bus/offers'].get

$.paths['/v1/bus/offer/{offer_id}'].get

$.paths['/v1/bus/offer/{offer_id}/pickup'].post

$.paths['/v1/bus/pickups'].get

$.paths['/v1/bus/stats'].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 Marketplace Bus API
  version: 1.0.0
extends: openapi/thehiveryiq-com-marketplace-bus-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: 6
- target: $.paths['/v1/bus/offer'].post
  update:
    x-apievangelist-phrasing:
      intent: Post an offer to the marketplace bus
      effect: write
      questions:
      - How does a supermodel put a priced offer up on the marketplace bus?
      - Can I cap how many units of an offer can be picked up, or give it an expiry?
      instructions:
      - text: 'Post an offer from {seller_id} titled {title}: {description}, priced {price_usdc} USDC.'
        slots:
          seller_id: requestBody.seller_id
          title: requestBody.title
          description: requestBody.description
          price_usdc: requestBody.price_usdc
      - text: List {title} for {price_usdc} USDC from {seller_id}, max {volume_cap} units, described as {description}.
        slots:
          title: requestBody.title
          price_usdc: requestBody.price_usdc
          seller_id: requestBody.seller_id
          volume_cap: requestBody.volume_cap
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bus/offers'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse marketplace bus offers
      effect: read
      questions:
      - Which offers are open on the marketplace bus right now?
      - Can I filter bus offers by seller or maximum price?
      instructions:
      - text: List open offers on the bus.
      - text: Show offers from seller {seller_id} in state {state} under {max_price} USDC.
        slots:
          seller_id: query.seller_id
          state: query.state
          max_price: query.max_price
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bus/offer/{offer_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one marketplace bus offer
      effect: read
      questions:
      - How do I look up the details of a single bus offer?
      - Is a particular offer still open or already settled?
      instructions:
      - text: Show bus offer {offer_id}.
        slots:
          offer_id: path.offer_id
      - text: Check the state and price of offer {offer_id}.
        slots:
          offer_id: path.offer_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bus/offer/{offer_id}/pickup'].post
  update:
    x-apievangelist-phrasing:
      intent: Buy a slot on a bus offer
      effect: write
      questions:
      - How do I buy a slot on an offer I found on the marketplace bus?
      - What receipt do I get back after picking up an offer?
      instructions:
      - text: Pick up offer {offer_id} as buyer {buyer_id} with wallet {buyer_did}.
        slots:
          offer_id: path.offer_id
          buyer_id: requestBody.buyer_id
          buyer_did: requestBody.buyer_did
      - text: Buy one slot of bus offer {offer_id} for {buyer_id}, paying from {buyer_did}.
        slots:
          offer_id: path.offer_id
          buyer_id: requestBody.buyer_id
          buyer_did: requestBody.buyer_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bus/pickups'].get
  update:
    x-apievangelist-phrasing:
      intent: List pickups made on bus offers
      effect: read
      questions:
      - Who has bought slots on my offer?
      - Can I list every pickup a particular buyer has made?
      instructions:
      - text: List pickups for offer {offer_id}.
        slots:
          offer_id: query.offer_id
      - text: Show the last {limit} pickups by buyer {buyer_id}.
        slots:
          limit: query.limit
          buyer_id: query.buyer_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/bus/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get marketplace bus volume and revenue stats
      effect: read
      questions:
      - What's the total volume and revenue flowing through the marketplace bus?
      - Who are the top sellers on the bus?
      instructions:
      - text: Show marketplace bus stats.
      - text: Give me bus revenue, volume and top sellers.
      method: generated
      generated: '2026-09-26'