The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Gateway Server Gs API

3 actions 3 updates phrasing extends openapi/the-things-network-gs-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['/gs/gateways/connection/stats'].post
$.paths['/gs/gateways/{gateway_id}/connection/stats'].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 — Gateway Server Gs API
  version: 1.0.0
extends: openapi/the-things-network-gs-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['/gs/gateways/connection/stats'].post
  update:
    x-apievangelist-phrasing:
      intent: Get connection stats for many gateways
      effect: read
      questions:
      - Can I get connection statistics for several gateways in one call?
      - Are gateways that aren't connected included in batch connection stats?
      instructions:
      - text: Get connection stats for gateways {gateway_ids}.
        slots:
          gateway_ids: requestBody.gateway_ids
      - text: Show {field_mask} connection stats for gateways {gateway_ids}.
        slots:
          field_mask: requestBody.field_mask
          gateway_ids: requestBody.gateway_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gs/gateways/{gateway_id}/connection/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one gateway's connection stats
      effect: read
      questions:
      - How do I see whether my gateway is connected and when it last sent traffic?
      - Do a single gateway's connection stats survive a reconnect?
      instructions:
      - text: Show the connection stats of gateway {gateway_id}.
        slots:
          gateway_id: path.gateway_id
      - text: Check the current Gateway Server connection of {gateway_id}.
        slots:
          gateway_id: path.gateway_id
      method: generated
      generated: '2026-09-26'