The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Network Server Ns API

5 actions 5 updates phrasing extends openapi/the-things-network-ns-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['/ns/default_mac_settings/{frequency_plan_id}/{lorawan_phy_version}'].get

$.paths['/ns/dev_addr'].get

$.paths['/ns/dev_addr_prefixes'].get

$.paths['/ns/net_id'].get

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 Things Stack — Network Server Ns API
  version: 1.0.0
extends: openapi/the-things-network-ns-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['/ns/default_mac_settings/{frequency_plan_id}/{lorawan_phy_version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default MAC settings for a frequency plan
      effect: read
      questions:
      - What default MAC settings does the Network Server use for a frequency plan?
      - Do the defaults change with the LoRaWAN PHY version?
      instructions:
      - text: Get the default MAC settings for frequency plan {frequency_plan_id} on PHY version {lorawan_phy_version}.
        slots:
          frequency_plan_id: path.frequency_plan_id
          lorawan_phy_version: path.lorawan_phy_version
      - text: Show MAC defaults for {frequency_plan_id} with {lorawan_phy_version}.
        slots:
          frequency_plan_id: path.frequency_plan_id
          lorawan_phy_version: path.lorawan_phy_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ns/dev_addr'].get
  update:
    x-apievangelist-phrasing:
      intent: Request a device address from the Network Server
      effect: read
      questions:
      - How do I get a DevAddr assigned for an ABP device?
      - Can the Network Server hand me a new device address?
      instructions:
      - text: Generate a new DevAddr.
      - text: Request a device address assignment from the Network Server.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ns/dev_addr_prefixes'].get
  update:
    x-apievangelist-phrasing:
      intent: List the Network Server's DevAddr prefixes
      effect: read
      questions:
      - Which DevAddr prefixes is this Network Server configured to use?
      - What address ranges will device addresses be allocated from?
      instructions:
      - text: List the device address prefixes.
      - text: Show the DevAddr prefixes this network uses.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ns/net_id'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Network Server's NetID
      effect: read
      questions:
      - What NetID is this Network Server operating under?
      - Can I look up the LoRaWAN network identifier of the server?
      instructions:
      - text: Get the NetID.
      - text: Show which NetID the Network Server has.
      method: generated
      generated: '2026-09-26'