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-enddevicebatchclaimingserver-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['/edcs/claim/info/batch'].post
$.paths['/edcs/claim/{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-enddevicebatchclaimingserver-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['/edcs/claim/info/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Check claiming support for many JoinEUIs
      effect: read
      questions:
      - Can I check claiming support for a whole list of JoinEUIs in one request?
      - Which of my JoinEUIs can be claimed on this network?
      instructions:
      - text: Check claiming support for the JoinEUIs in {requests}.
        slots:
          requests: requestBody.requests
      - text: 'Tell me which of these JoinEUIs support claiming: {requests}.'
        slots:
          requests: requestBody.requests
      method: generated
      generated: '2026-09-26'
- target: $.paths['/edcs/claim/{application_ids.application_id}/devices/batch'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unclaim a batch of end devices
      effect: destructive
      questions:
      - How do I unclaim many devices from an external Join Server at once?
      - Do all devices in a batch unclaim need to belong to the same application?
      instructions:
      - text: Unclaim devices {device_ids} in application {application_id}.
        slots:
          device_ids: query.device_ids
          application_id: path.application_ids.application_id
      - text: Release the claims on {device_ids} from app {application_id} and report any that failed.
        slots:
          device_ids: query.device_ids
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'