Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Pilot API

4 actions 4 updates phrasing extends openapi/thehiveryiq-com-pilot-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/pilot/accept'].post
$.paths['/v1/pilot/accepts/recent'].get
$.paths['/v1/pilot/health'].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 Pilot API
  version: 1.0.0
extends: openapi/thehiveryiq-com-pilot-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/pilot/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Countersign a pilot offer
      effect: write
      questions:
      - How do I accept and countersign a pilot offer?
      - What deposit instructions come back when I accept a pilot?
      instructions:
      - text: Accept pilot {slug} for {company} as {accepted_by_name} ({accepted_by_email}) with a {deposit_amount_usd} USD deposit.
        slots:
          slug: requestBody.slug
          company: requestBody.company
          accepted_by_name: requestBody.accepted_by_name
          accepted_by_email: requestBody.accepted_by_email
          deposit_amount_usd: requestBody.deposit_amount_usd
      - text: Countersign pilot offer {slug} on behalf of {company}, signed by {accepted_by_name}, email {accepted_by_email}, deposit {deposit_amount_usd}.
        slots:
          slug: requestBody.slug
          company: requestBody.company
          accepted_by_name: requestBody.accepted_by_name
          accepted_by_email: requestBody.accepted_by_email
          deposit_amount_usd: requestBody.deposit_amount_usd
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pilot/accepts/recent'].get
  update:
    x-apievangelist-phrasing:
      intent: List recently accepted pilots
      effect: read
      questions:
      - Which pilot offers have been accepted recently?
      - Can an operator review the latest pilot acceptances?
      instructions:
      - text: Show recent pilot acceptances.
      - text: List the last {limit} accepted pilots.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pilot/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check pilot service health
      effect: read
      questions:
      - Is the pilot acceptance service up?
      - How do I health-check the pilot endpoints?
      instructions:
      - text: Check pilot service health.
      - text: Ping the pilot health endpoint.
      method: generated
      generated: '2026-09-26'