The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/the-things-network-enddevicebatchregistry-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['/applications/{application_ids.application_id}/devices/batch'].get
$.paths['/applications/{application_ids.application_id}/devices/batch'].delete

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 — End Device Registry End Device Batch…
  version: 1.0.0
extends: openapi/the-things-network-enddevicebatchregistry-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['/applications/{application_ids.application_id}/devices/batch'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several end devices at once
      effect: read
      questions:
      - Can I fetch multiple end devices in one call?
      - What happens if some device IDs in a batch lookup don't exist?
      instructions:
      - text: Get devices {device_ids} from application {application_id}.
        slots:
          device_ids: query.device_ids
          application_id: path.application_ids.application_id
      - text: Fetch fields {field_mask} for devices {device_ids} in {application_id}.
        slots:
          field_mask: query.field_mask
          device_ids: query.device_ids
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{application_ids.application_id}/devices/batch'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several end devices from the registry
      effect: destructive
      questions:
      - How do I delete a batch of end devices from the Identity Server in one go?
      - Is batch device deletion in the registry all-or-nothing?
      instructions:
      - text: Delete registry devices {device_ids} from application {application_id}.
        slots:
          device_ids: query.device_ids
          application_id: path.application_ids.application_id
      - text: Remove end devices {device_ids} of {application_id} from the device registry atomically.
        slots:
          device_ids: query.device_ids
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'