The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Identity Server End Device Registry Search…

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

$.info
$.paths['/search/applications/{application_ids.application_id}/devices'].get

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 — Identity Server End Device Registry Search…
  version: 1.0.0
extends: openapi/the-things-network-enddeviceregistrysearch-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: 1
- target: $.paths['/search/applications/{application_ids.application_id}/devices'].get
  update:
    x-apievangelist-phrasing:
      intent: Search end devices in an application
      effect: read
      questions:
      - Is there a way to find a device in my application by part of its name or DevEUI?
      - Can I search devices by attribute values or DevAddr substring?
      instructions:
      - text: Search application {application_id} for devices matching {query}.
        slots:
          application_id: path.application_ids.application_id
          query: query.query
      - text: Find devices in app {application_id} whose DevEUI contains {dev_eui_contains}.
        slots:
          application_id: path.application_ids.application_id
          dev_eui_contains: query.dev_eui_contains
      - text: Find devices in app {application_id} whose name contains {name_contains}.
        slots:
          application_id: path.application_ids.application_id
          name_contains: query.name_contains
      method: generated
      generated: '2026-09-26'