The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack Events API

3 actions 3 updates phrasing extends openapi/the-things-network-events-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for The Things Network / The Things Stack's API. It is a proposal applied on top of the contract, not a document The Things Network / The Things Stack publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/events'].post
$.paths['/events/related'].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 Things Stack Events API
  version: 1.0.0
extends: openapi/the-things-network-events-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['/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Stream live events
      effect: read
      questions:
      - How do I watch live events for my applications, gateways or devices?
      - Can I include a tail of recent historical events in the stream?
      - Can I only stream events with certain names?
      instructions:
      - text: Stream live events for {identifiers}.
        slots:
          identifiers: requestBody.identifiers
      - text: Stream events for {identifiers} with the last {tail} historical events.
        slots:
          identifiers: requestBody.identifiers
          tail: requestBody.tail
      - text: Stream only events named {names} for {identifiers}.
        slots:
          names: requestBody.names
          identifiers: requestBody.identifiers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/related'].get
  update:
    x-apievangelist-phrasing:
      intent: Find events related by correlation ID
      effect: read
      questions:
      - How do I find all events that share a correlation ID?
      - Can I trace everything related to one uplink or request?
      instructions:
      - text: Find events related to correlation ID {correlation_id}.
        slots:
          correlation_id: query.correlation_id
      - text: Trace every event tagged with correlation {correlation_id}.
        slots:
          correlation_id: query.correlation_id
      method: generated
      generated: '2026-09-26'