The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/the-things-network-gtwgs-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/{gateway_id}/mqtt-connection-info'].get
$.paths['/gs/gateways/{gateway_id}/mqttv2-connection-info'].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 Gtw Gs API
  version: 1.0.0
extends: openapi/the-things-network-gtwgs-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/{gateway_id}/mqtt-connection-info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get MQTT connection info for a gateway
      effect: read
      questions:
      - How do I connect a gateway to the Gateway Server over MQTT?
      - What MQTT address and username does my gateway need?
      instructions:
      - text: Get MQTT connection details for gateway {gateway_id}.
        slots:
          gateway_id: path.gateway_id
      - text: Show how gateway {gateway_id} should connect over MQTT.
        slots:
          gateway_id: path.gateway_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gs/gateways/{gateway_id}/mqttv2-connection-info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get legacy V2 MQTT connection info for a gateway
      effect: read
      questions:
      - How do I connect an older The Things Network Stack V2 MQTT gateway?
      - Is there legacy MQTT connection info for V2 gateways?
      instructions:
      - text: Get legacy V2 MQTT connection details for gateway {gateway_id}.
        slots:
          gateway_id: path.gateway_id
      - text: Show the Stack V2 MQTT settings for gateway {gateway_id}.
        slots:
          gateway_id: path.gateway_id
      method: generated
      generated: '2026-09-26'