Merge pull request #7573 from TheThingsNetwork/feature/batch-mac-settings-profile

Set, unset MAC settings profile to batch of end devices

Author: halimi

CHANGELOG.md

@@ -11,6 +11,9 @@ For details about compatibility between different releases, see the **Commitment
 
 ### Added
 
+- Support to associate/disassociate MAC settings profiles to batch of end devices
+  - This feature is experimental and subject to change.
+
 ### Changed
 
 ### Deprecated

api/ttn/lorawan/v3/api.md

@@ -244,6 +244,7 @@
   - [Message `ADRSettings.StaticMode`](#ttn.lorawan.v3.ADRSettings.StaticMode)
   - [Message `BatchDeleteEndDevicesRequest`](#ttn.lorawan.v3.BatchDeleteEndDevicesRequest)
   - [Message `BatchGetEndDevicesRequest`](#ttn.lorawan.v3.BatchGetEndDevicesRequest)
+  - [Message `BatchSetMACSettingsProfileRequest`](#ttn.lorawan.v3.BatchSetMACSettingsProfileRequest)
   - [Message `BatchUpdateEndDeviceLastSeenRequest`](#ttn.lorawan.v3.BatchUpdateEndDeviceLastSeenRequest)
   - [Message `BatchUpdateEndDeviceLastSeenRequest.EndDeviceLastSeenUpdate`](#ttn.lorawan.v3.BatchUpdateEndDeviceLastSeenRequest.EndDeviceLastSeenUpdate)
   - [Message `BoolValue`](#ttn.lorawan.v3.BoolValue)
@@ -3929,6 +3930,21 @@ Configuration options for static ADR.
 | `application_ids` | <p>`message.required`: `true`</p> |
 | `device_ids` | <p>`repeated.min_items`: `1`</p><p>`repeated.max_items`: `20`</p><p>`repeated.items.string.max_len`: `36`</p><p>`repeated.items.string.pattern`: `^[a-z0-9](?:[-]?[a-z0-9]){2,}$`</p> |
 
+### <a name="ttn.lorawan.v3.BatchSetMACSettingsProfileRequest">Message `BatchSetMACSettingsProfileRequest`</a>
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `application_ids` | [`ApplicationIdentifiers`](#ttn.lorawan.v3.ApplicationIdentifiers) |  |  |
+| `mac_settings_profile_ids` | [`MACSettingsProfileIdentifiers`](#ttn.lorawan.v3.MACSettingsProfileIdentifiers) |  |  |
+| `device_ids` | [`string`](#string) | repeated |  |
+
+#### Field Rules
+
+| Field | Validations |
+| ----- | ----------- |
+| `application_ids` | <p>`message.required`: `true`</p> |
+| `device_ids` | <p>`repeated.min_items`: `1`</p><p>`repeated.max_items`: `20`</p><p>`repeated.items.string.max_len`: `36`</p><p>`repeated.items.string.pattern`: `^[a-z0-9](?:[-]?[a-z0-9]){2,}$`</p> |
+
 ### <a name="ttn.lorawan.v3.BatchUpdateEndDeviceLastSeenRequest">Message `BatchUpdateEndDeviceLastSeenRequest`</a>
 
 | Field | Type | Label | Description |
@@ -9433,12 +9449,14 @@ The NsEndDeviceBatchRegistry service allows clients to manage batches of end dev
 | Method Name | Request Type | Response Type | Description |
 | ----------- | ------------ | ------------- | ------------|
 | `Delete` | [`BatchDeleteEndDevicesRequest`](#ttn.lorawan.v3.BatchDeleteEndDevicesRequest) | [`.google.protobuf.Empty`](#google.protobuf.Empty) | Delete a list of devices within the same application. This operation is atomic; either all devices are deleted or none. Devices not found are skipped and no error is returned. |
+| `SetMACSettingsProfile` | [`BatchSetMACSettingsProfileRequest`](#ttn.lorawan.v3.BatchSetMACSettingsProfileRequest) | [`EndDevices`](#ttn.lorawan.v3.EndDevices) | Set the MAC settings profile for a batch of end devices. |
 
 #### HTTP bindings
 
 | Method Name | Method | Pattern | Body |
 | ----------- | ------ | ------- | ---- |
 | `Delete` | `DELETE` | `/api/v3/ns/applications/{application_ids.application_id}/devices/batch` |  |
+| `SetMACSettingsProfile` | `POST` | `/api/v3/ns/applications/{application_ids.application_id}/devices/mac_settings_profile/batch` | `*` |
 
 ### <a name="ttn.lorawan.v3.NsEndDeviceRegistry">Service `NsEndDeviceRegistry`</a>
 

api/ttn/lorawan/v3/api.swagger.json

@@ -10194,6 +10194,45 @@
         ]
       }
     },
+    "/ns/applications/{application_ids.application_id}/devices/mac_settings_profile/batch": {
+      "post": {
+        "summary": "Set the MAC settings profile for a batch of end devices.",
+        "operationId": "NsEndDeviceBatchRegistry_SetMACSettingsProfile",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/v3EndDevices"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/googlerpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "application_ids.application_id",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/NsEndDeviceBatchRegistrySetMACSettingsProfileBody"
+            }
+          }
+        ],
+        "tags": [
+          "NsEndDeviceBatchRegistry"
+        ]
+      }
+    },
     "/ns/applications/{application_ids.application_id}/devices/{device_id}": {
       "delete": {
         "summary": "Delete deletes the device that matches the given identifiers.\nIf there are multiple matches, an error will be returned.",
@@ -18867,6 +18906,23 @@
         }
       }
     },
+    "NsEndDeviceBatchRegistrySetMACSettingsProfileBody": {
+      "type": "object",
+      "properties": {
+        "application_ids": {
+          "type": "object"
+        },
+        "mac_settings_profile_ids": {
+          "$ref": "#/definitions/v3MACSettingsProfileIdentifiers"
+        },
+        "device_ids": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
     "NsEndDeviceRegistryResetFactoryDefaultsBody": {
       "type": "object",
       "properties": {

api/ttn/lorawan/v3/end_device.proto

@@ -1435,3 +1435,18 @@ message BatchGetEndDevicesRequest {
   reserved 6;
   reserved "page";
 }
+
+message BatchSetMACSettingsProfileRequest {
+  ttn.lorawan.v3.ApplicationIdentifiers application_ids = 1 [(validate.rules).message.required = true];
+  MACSettingsProfileIdentifiers mac_settings_profile_ids = 2;
+  repeated string device_ids = 3 [(validate.rules).repeated = {
+    min_items: 1,
+    max_items: 20,
+    items: {
+      string: {
+        pattern: "^[a-z0-9](?:[-]?[a-z0-9]){2,}$",
+        max_len: 36
+      }
+    }
+  }];
+}

api/ttn/lorawan/v3/networkserver.proto

@@ -182,4 +182,12 @@ service NsEndDeviceBatchRegistry {
   rpc Delete(BatchDeleteEndDevicesRequest) returns (google.protobuf.Empty) {
     option (google.api.http) = {delete: "/ns/applications/{application_ids.application_id}/devices/batch"};
   }
+
+  // Set the MAC settings profile for a batch of end devices.
+  rpc SetMACSettingsProfile(BatchSetMACSettingsProfileRequest) returns (EndDevices) {
+    option (google.api.http) = {
+      post: "/ns/applications/{application_ids.application_id}/devices/mac_settings_profile/batch"
+      body: "*"
+    };
+  }
 }