The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Network Server Ns End Device Batch Registry…

3 actions 3 updates phrasing extends openapi/the-things-network-nsenddevicebatchregistry-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['/ns/applications/{application_ids.application_id}/devices/batch'].delete
$.paths['/ns/applications/{application_ids.application_id}/devices/mac_settings_profile/batch'].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 — Network Server Ns End Device Batch Registry…
  version: 1.0.0
extends: openapi/the-things-network-nsenddevicebatchregistry-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['/ns/applications/{application_ids.application_id}/devices/batch'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a batch of devices from the Network Server
      effect: destructive
      questions:
      - How do I delete many devices from the Network Server in one atomic call?
      - What happens to device IDs that aren't found in a Network Server batch delete?
      instructions:
      - text: Delete devices {device_ids} from the Network Server in application {application_id}.
        slots:
          device_ids: query.device_ids
          application_id: path.application_ids.application_id
      - text: Remove Network Server records for {device_ids} in app {application_id} all at once.
        slots:
          device_ids: query.device_ids
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ns/applications/{application_ids.application_id}/devices/mac_settings_profile/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a MAC settings profile to many devices
      effect: write
      questions:
      - Can I assign one MAC settings profile to a batch of devices at once?
      - Which devices get updated when I set a MAC profile in bulk?
      instructions:
      - text: Apply MAC settings profile {mac_settings_profile_ids} to devices {device_ids} in application {application_id}.
        slots:
          mac_settings_profile_ids: requestBody.mac_settings_profile_ids
          device_ids: requestBody.device_ids
          application_id: path.application_ids.application_id
      - text: Set the MAC profile for devices {device_ids} in app {application_id}.
        slots:
          device_ids: requestBody.device_ids
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'