Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Storefront API

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

$.info
$.paths['/v1/storefront'].get
$.paths['/v1/storefront/search'].get
$.paths['/v1/storefront/{shape_or_id}'].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 Storefront API
  version: 1.0.0
extends: openapi/thehiveryiq-com-storefront-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: 3
- target: $.paths['/v1/storefront'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse the full storefront catalog
      effect: read
      questions:
      - What supermodels and offerings are on the storefront?
      - Can I include cold supermodels in the full catalog?
      instructions:
      - text: Show me the whole storefront.
      - text: List the full storefront catalog with include_cold set to {include_cold}.
        slots:
          include_cold: query.include_cold
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/storefront/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the storefront by capability or price
      effect: read
      questions:
      - Which storefront offerings fit my budget?
      - Can I search the storefront for a capability that accepts a particular asset?
      instructions:
      - text: Search the storefront for {capability}.
        slots:
          capability: query.capability
      - text: Find offerings priced between {min_price} and {max_price} that accept {asset}.
        slots:
          min_price: query.min_price
          max_price: query.max_price
          asset: query.asset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/storefront/{shape_or_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one storefront entry by shape or ID
      effect: read
      questions:
      - How do I look up a single supermodel on the storefront?
      - Can I fetch a storefront entry by its ID instead of its shape name?
      instructions:
      - text: Get the storefront entry for {shape_or_id}.
        slots:
          shape_or_id: path.shape_or_id
      - text: Look up storefront entry {shape_or_id} by {by}.
        slots:
          shape_or_id: path.shape_or_id
          by: query.by
      method: generated
      generated: '2026-09-26'