Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Github App API

4 actions 4 updates phrasing extends openapi/thehiveryiq-com-github-app-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/github/health'].get
$.paths['/v1/github/sign-diff'].post
$.paths['/v1/github/webhook'].post

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 Github App API
  version: 1.0.0
extends: openapi/thehiveryiq-com-github-app-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/github/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the GitHub signing app health
      effect: read
      questions:
      - Is the GitHub PR-signing app service up?
      - Can I health-check the GitHub integration?
      instructions:
      - text: Check the GitHub app service health.
      - text: Ping the PR-signing integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/github/sign-diff'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign a pull request diff
      effect: write
      questions:
      - How do I post-quantum sign a pull request diff from my CI pipeline?
      - Can I sign a PR diff without installing the GitHub App?
      instructions:
      - text: Sign the diff {diff} for PR {pr_number} in {repo}.
        slots:
          diff: requestBody.diff
          pr_number: requestBody.pr_number
          repo: requestBody.repo
      - text: Sign PR {pr_number} on {repo} from {base_sha} to {head_sha} with diff {diff}.
        slots:
          pr_number: requestBody.pr_number
          repo: requestBody.repo
          base_sha: requestBody.base_sha
          head_sha: requestBody.head_sha
          diff: requestBody.diff
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/github/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Receive GitHub pull request webhooks
      effect: write
      questions:
      - Which pull request events does the app's webhook handle?
      - Where should GitHub deliver pull_request events so diffs get signed automatically?
      instructions:
      - text: Deliver this pull_request webhook event to the signing app.
      - text: Send an opened PR event to the GitHub webhook receiver.
      method: generated
      generated: '2026-09-26'