Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Portal V2 API

6 actions 6 updates phrasing extends openapi/thehiveryiq-com-portal-v2-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 6

$.info

$.paths['/v1/portal/v2/signup'].post

$.paths['/v1/portal/v2/{tenant_id}/profile'].get

$.paths['/v1/portal/v2/{tenant_id}/tile-prefs'].post

$.paths['/v1/portal/v2/{tenant_id}/wisdom'].get

$.paths['/v1/portal/v2/{tenant_id}/features/activate'].post

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 Portal V2 API
  version: 1.0.0
extends: openapi/thehiveryiq-com-portal-v2-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: 5
- target: $.paths['/v1/portal/v2/signup'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign up a new portal tenant
      effect: write
      questions:
      - How do I create a tenant in the portal from a company domain?
      - Does signup work out my industry vertical automatically?
      instructions:
      - text: Sign up tenant {tenant_id} for {company_domain} with email {email}.
        slots:
          tenant_id: requestBody.tenant_id
          company_domain: requestBody.company_domain
          email: requestBody.email
      - text: Create portal tenant {tenant_id} for domain {company_domain}, contact {email}.
        slots:
          tenant_id: requestBody.tenant_id
          company_domain: requestBody.company_domain
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/portal/v2/{tenant_id}/profile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant's portal profile
      effect: read
      questions:
      - What does the portal know about my tenant's brand and vertical?
      - Will a demo tenant ID still return a profile?
      instructions:
      - text: Show the profile for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Get portal profile {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/portal/v2/{tenant_id}/tile-prefs'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a portal tile's visibility
      effect: write
      questions:
      - How do I show or hide a tile on my tenant portal?
      - Can I make a portal tile public?
      instructions:
      - text: Set tile {tile_key} for tenant {tenant_id} to exposed {exposed} and public {public}.
        slots:
          tile_key: requestBody.tile_key
          tenant_id: path.tenant_id
          exposed: requestBody.exposed
          public: requestBody.public
      - text: 'Update tile {tile_key} on {tenant_id}''s portal: exposed {exposed}, public {public}.'
        slots:
          tile_key: requestBody.tile_key
          tenant_id: path.tenant_id
          exposed: requestBody.exposed
          public: requestBody.public
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/portal/v2/{tenant_id}/wisdom'].get
  update:
    x-apievangelist-phrasing:
      intent: Get AI recommendations for a tenant
      effect: read
      questions:
      - What AI recommendations does the portal have for my business?
      - Are the tenant recommendations cached or fresh?
      instructions:
      - text: Get recommendations for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Show portal wisdom for {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/portal/v2/{tenant_id}/features/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a feature for a tenant
      effect: write
      questions:
      - How do I turn on a paid feature for my tenant?
      - When is an activated portal feature billed?
      instructions:
      - text: Activate feature {feature_id} for tenant {tenant_id}.
        slots:
          feature_id: requestBody.feature_id
          tenant_id: path.tenant_id
      - text: Enable {feature_id} on {tenant_id} and show me the pricing.
        slots:
          feature_id: requestBody.feature_id
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'