Hubble Network · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hubble Platform Packets API

3 actions 3 updates phrasing extends openapi/hubble-network-packets-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Hubble Network's API. It is a proposal applied on top of the contract, not a document Hubble Network publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/org/{org_id}/packets'].get

$.paths['/v1/webhook/testBatch'].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 Hubble Platform Packets API
  version: 1.0.0
extends: openapi/hubble-network-packets-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: 2
- target: $.paths['/v1/org/{org_id}/packets'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve or stream device packets
      effect: read
      questions:
      - How do I pull the packets my devices have sent to the network?
      - Can I fetch packets for just one device over a specific time range?
      - How do I keep ingesting new packets incrementally without missing any?
      instructions:
      - text: Retrieve packets for organization {org_id} received between {start} and {end}.
        slots:
          org_id: path.org_id
          start: query.start
          end: query.end
      - text: Get packets from device {device_id} in org {org_id}.
        slots:
          device_id: query.device_id
          org_id: path.org_id
      - text: Continue the packet stream for org {org_id} from token {Continuation-Token}.
        slots:
          org_id: path.org_id
          Continuation-Token: header.Continuation-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhook/testBatch'].post
  update:
    x-apievangelist-phrasing:
      intent: See the packet batch format a webhook receives
      effect: write
      questions:
      - What does the payload look like when packet batches are posted to my webhook?
      - Which header should my receiving endpoint check to confirm a request really came from Hubble?
      instructions:
      - text: Post the example packet batch {packets} to the sample receiver with token {HTTP-X-HUBBLE-TOKEN}.
        slots:
          packets: requestBody.packets
          HTTP-X-HUBBLE-TOKEN: header.HTTP-X-HUBBLE-TOKEN
      - text: Show me how the reference webhook receiver accepts a packet batch signed with {HTTP-X-HUBBLE-TOKEN}.
        slots:
          HTTP-X-HUBBLE-TOKEN: header.HTTP-X-HUBBLE-TOKEN
      method: generated
      generated: '2026-09-26'