# 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 Distribution API
  version: 1.0.0
extends: openapi/thehiveryiq-com-distribution-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: 8
- target: $.paths['/v1/discovery/register'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered shim capabilities
      effect: read
      questions:
      - Which capabilities have shims registered for discovery?
      - Can I see the discovery registration for just one shim?
      instructions:
      - text: List all registered discovery capabilities.
      - text: Show the discovery capabilities registered by shim {shim}.
        slots:
          shim: query.shim
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/discovery/register'].post
  update:
    x-apievangelist-phrasing:
      intent: Register capabilities for a shim
      effect: write
      questions:
      - How do I register my shim's tools and endpoint for discovery?
      - Can I include a repo and DID when registering a shim's capabilities?
      instructions:
      - text: Register discovery capabilities for shim {shim}.
        slots:
          shim: requestBody.shim
      - text: Register shim {shim} at endpoint {endpoint} with tools {tools}.
        slots:
          shim: requestBody.shim
          endpoint: requestBody.endpoint
          tools: requestBody.tools
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/gate/register'].get
  update:
    x-apievangelist-phrasing:
      intent: List gate manifests by ecosystem
      effect: read
      questions:
      - What gate manifests are registered, grouped by ecosystem?
      - Can I filter the gate manifests to a single ecosystem?
      instructions:
      - text: List gate manifests grouped by ecosystem.
      - text: Show gate manifests for ecosystem {ecosystem}.
        slots:
          ecosystem: query.ecosystem
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/gate/register'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a per-ecosystem gate manifest
      effect: write
      questions:
      - How do I publish a gate manifest for my shim in a specific ecosystem?
      - Can I attach a manifest body when registering a gate?
      instructions:
      - text: Register a gate for shim {shim} in ecosystem {ecosystem}.
        slots:
          shim: requestBody.shim
          ecosystem: requestBody.ecosystem
      - text: Register gate manifest {manifest} for shim {shim} in {ecosystem}.
        slots:
          manifest: requestBody.manifest
          shim: requestBody.shim
          ecosystem: requestBody.ecosystem
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/marketplace/list'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse marketplace listings
      effect: read
      questions:
      - What tools are listed in the agent marketplace right now?
      - Can I browse marketplace listings for one shim only?
      instructions:
      - text: Browse the public marketplace listings.
      - text: Show marketplace listings for shim {shim}.
        slots:
          shim: query.shim
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/marketplace/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List a shim's tools in the marketplace
      effect: write
      questions:
      - How do I put my shim's tools up in the agent marketplace?
      - Can I publish a set of tools to the marketplace under my shim name?
      instructions:
      - text: Publish shim {shim}'s tools to the marketplace.
        slots:
          shim: requestBody.shim
      - text: Add tools {tools} to the marketplace for shim {shim}.
        slots:
          tools: requestBody.tools
          shim: requestBody.shim
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pulse/event'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a pulse event
      effect: write
      questions:
      - How do I append an event to the pulse ring buffer?
      - Can a shim attach a payload to a pulse event?
      instructions:
      - text: Record pulse event {event}.
        slots:
          event: requestBody.event
      - text: Append pulse event {event} from shim {shim} with payload {payload}.
        slots:
          event: requestBody.event
          shim: requestBody.shim
          payload: requestBody.payload
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pulse/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Read recent pulse events
      effect: read
      questions:
      - What pulse events happened in the last few minutes?
      - Can I filter recent pulse events by event name or shim, up to 500?
      instructions:
      - text: Show pulse events from the last {since_minutes} minutes.
        slots:
          since_minutes: query.since_minutes
      - text: Read up to {limit} {event} pulse events from shim {shim}.
        slots:
          limit: query.limit
          event: query.event
          shim: query.shim
      method: generated
      generated: '2026-09-26'