The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Gateway Server Managed Gateway Configuration…

5 actions 5 updates phrasing extends openapi/the-things-network-managedgatewayconfigurationservice-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 5

$.info
$.paths['/gcs/gateways/managed/{gateway.ids.gateway_id}'].put
$.paths['/gcs/gateways/managed/{gateway_ids.gateway_id}'].get
$.paths['/gcs/gateways/managed/{gateway_id}/events'].post
$.paths['/gcs/gateways/managed/{gateway_id}/wifi/scan'].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 Things Stack — Gateway Server Managed Gateway Configuration…
  version: 1.0.0
extends: openapi/the-things-network-managedgatewayconfigurationservice-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: 4
- target: $.paths['/gcs/gateways/managed/{gateway.ids.gateway_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a managed gateway's configuration
      effect: write
      questions:
      - How do I change the settings of a managed gateway?
      - Can I update only specific fields of a managed gateway's configuration?
      instructions:
      - text: Update managed gateway {gateway_id} with {gateway}.
        slots:
          gateway_id: path.gateway.ids.gateway_id
          gateway: requestBody.gateway
      - text: Change fields {field_mask} of managed gateway {gateway_id}.
        slots:
          field_mask: requestBody.field_mask
          gateway_id: path.gateway.ids.gateway_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/managed/{gateway_ids.gateway_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a managed gateway's configuration
      effect: read
      questions:
      - What configuration is my managed gateway running?
      - Can I read the managed settings for a gateway?
      instructions:
      - text: Show the managed configuration of gateway {gateway_id}.
        slots:
          gateway_id: path.gateway_ids.gateway_id
      - text: Get managed fields {field_mask} for gateway {gateway_id}.
        slots:
          field_mask: query.field_mask
          gateway_id: path.gateway_ids.gateway_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/managed/{gateway_id}/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Stream events from a managed gateway
      effect: read
      questions:
      - Can I watch live events coming from my managed gateway?
      - How do I follow what a managed gateway is doing in real time?
      instructions:
      - text: Stream events for managed gateway {gateway_id}.
        slots:
          gateway_id: path.gateway_id
      - text: Follow live managed-gateway events for {gateway_id} with EUI {eui}.
        slots:
          gateway_id: path.gateway_id
          eui: requestBody.eui
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/managed/{gateway_id}/wifi/scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Scan WiFi networks from a managed gateway
      effect: read
      questions:
      - Which WiFi access points can my managed gateway see?
      - How do I find nearby WiFi networks before setting up a gateway WiFi profile?
      instructions:
      - text: Scan for WiFi access points from managed gateway {gateway_id}.
        slots:
          gateway_id: path.gateway_id
      - text: List WiFi networks visible to gateway {gateway_id} with EUI {eui}.
        slots:
          gateway_id: path.gateway_id
          eui: requestBody.eui
      method: generated
      generated: '2026-09-26'