# 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 Registry API
  version: 1.0.0
extends: openapi/the-things-network-nsenddeviceregistry-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: 5
- target: $.paths['/ns/applications/{application_ids.application_id}/devices/{device_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device from the Network Server
      effect: destructive
      questions:
      - How do I remove an end device from the Network Server registry?
      - What happens if more than one Network Server device matches my identifiers?
      instructions:
      - text: Delete device {device_id} of application {application_id} from the Network Server.
        slots:
          device_id: path.device_id
          application_id: path.application_ids.application_id
      - text: Remove Network Server state for {device_id} in {application_id}.
        slots:
          device_id: path.device_id
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ns/applications/{end_device.ids.application_ids.application_id}/devices'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a device on the Network Server
      effect: write
      questions:
      - How do I add a new end device's MAC settings to the Network Server?
      - Can I create a Network Server device without the device ID in the path?
      instructions:
      - text: Create device {end_device} on the Network Server for application {application_id}.
        slots:
          end_device: requestBody.end_device
          application_id: path.end_device.ids.application_ids.application_id
      - text: Register a new end device's network-layer settings in {application_id}.
        slots:
          application_id: path.end_device.ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ns/applications/{end_device.ids.application_ids.application_id}/devices/{end_device.ids.device_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a device on the Network Server
      effect: write
      questions:
      - How do I change an existing device's network-layer settings like its MAC version?
      - Can I update only certain Network Server device fields?
      instructions:
      - text: Update Network Server device {device_id} in application {application_id} with {end_device}.
        slots:
          device_id: path.end_device.ids.device_id
          application_id: path.end_device.ids.application_ids.application_id
          end_device: requestBody.end_device
      - text: Change fields {field_mask} of device {device_id} on the Network Server in {application_id}.
        slots:
          field_mask: requestBody.field_mask
          device_id: path.end_device.ids.device_id
          application_id: path.end_device.ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ns/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device's Network Server state
      effect: read
      questions:
      - What network-layer settings and session does the Network Server hold for my device?
      - Can I read a device's MAC state from the Network Server?
      instructions:
      - text: Show the Network Server record for device {device_id} in application {application_id}.
        slots:
          device_id: path.end_device_ids.device_id
          application_id: path.end_device_ids.application_ids.application_id
      - text: Get Network Server fields {field_mask} for {device_id} in {application_id}.
        slots:
          field_mask: query.field_mask
          device_id: path.end_device_ids.device_id
          application_id: path.end_device_ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ns/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Reset a device to factory defaults
      effect: destructive
      questions:
      - How do I reset an end device's Network Server state to factory defaults?
      - Can I wipe a device's MAC state without deleting it?
      instructions:
      - text: Reset device {device_id} in application {application_id} to factory defaults.
        slots:
          device_id: path.end_device_ids.device_id
          application_id: path.end_device_ids.application_ids.application_id
      - text: Factory-reset the Network Server state of {device_id} in {application_id}.
        slots:
          device_id: path.end_device_ids.device_id
          application_id: path.end_device_ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'