api: Add band ID to list frequency plans request

TheThingsNetwork · Nov 16, 2023 · babcb17 · babcb17
1 parent cb059bb
commit babcb17
Show file tree

Hide file tree

Showing 11 changed files with 360 additions and 296 deletions.
diff --git a/api/ttn/lorawan/v3/api.md b/api/ttn/lorawan/v3/api.md
@@ -2715,6 +2715,7 @@ PeerInfo
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | `base_frequency` | [`uint32`](#uint32) |  | Optional base frequency in MHz for hardware support (433, 470, 868 or 915) |
+| `band_id` | [`string`](#string) |  | Optional Band ID to filter the results. |
 
 ### <a name="ttn.lorawan.v3.ListFrequencyPlansResponse">Message `ListFrequencyPlansResponse`</a>
 

diff --git a/api/ttn/lorawan/v3/api.swagger.json b/api/ttn/lorawan/v3/api.swagger.json
@@ -6707,6 +6707,13 @@
             "required": false,
             "type": "integer",
             "format": "int64"
+          },
+          {
+            "name": "band_id",
+            "description": "Optional Band ID to filter the results.",
+            "in": "query",
+            "required": false,
+            "type": "string"
           }
         ],
         "tags": [

diff --git a/api/ttn/lorawan/v3/configuration_services.proto b/api/ttn/lorawan/v3/configuration_services.proto
@@ -32,6 +32,8 @@ message ListFrequencyPlansRequest {
   };
   // Optional base frequency in MHz for hardware support (433, 470, 868 or 915)
   uint32 base_frequency = 1;
+  // Optional Band ID to filter the results.
+  string band_id = 2;
 }
 
 message FrequencyPlanDescription {

diff --git a/pkg/frequencyplans/rpc.go b/pkg/frequencyplans/rpc.go
@@ -39,6 +39,9 @@ func (s *RPCServer) ListFrequencyPlans(ctx context.Context, req *ttnpb.ListFrequ
 		if req.BaseFrequency != 0 && uint16(req.BaseFrequency) != desc.BaseFrequency {
 			continue
 		}
+		if req.BandId != "" && req.BandId != desc.BandID {
+			continue
+		}
 		res.FrequencyPlans = append(res.FrequencyPlans, &ttnpb.FrequencyPlanDescription{
 			Id:            desc.ID,
 			BandId:        desc.BandID,

diff --git a/pkg/frequencyplans/rpc_test.go b/pkg/frequencyplans/rpc_test.go
@@ -79,4 +79,11 @@ func TestRPCServer(t *testing.T) {
 	a.So(err, should.BeNil)
 	a.So(base915.FrequencyPlans, should.HaveLength, 2)
 	a.So(base915.FrequencyPlans, should.Resemble, expectedAll[:2])
+
+	bandAS, err := server.ListFrequencyPlans(context.Background(), &ttnpb.ListFrequencyPlansRequest{
+		BandId: "AS_923",
+	})
+	a.So(err, should.BeNil)
+	a.So(bandAS.FrequencyPlans, should.HaveLength, 1)
+	a.So(bandAS.FrequencyPlans[0], should.Resemble, expectedAll[1])
 }
diff --git a/pkg/ttnpb/configuration_services.pb.go b/pkg/ttnpb/configuration_services.pb.go
diff --git a/pkg/ttnpb/configuration_services.pb.paths.fm.go b/pkg/ttnpb/configuration_services.pb.paths.fm.go
diff --git a/pkg/ttnpb/configuration_services.pb.setters.fm.go b/pkg/ttnpb/configuration_services.pb.setters.fm.go
diff --git a/pkg/ttnpb/configuration_services.pb.validate.go b/pkg/ttnpb/configuration_services.pb.validate.go
diff --git a/pkg/ttnpb/configuration_services_flags.pb.go b/pkg/ttnpb/configuration_services_flags.pb.go
diff --git a/sdk/js/generated/api.json b/sdk/js/generated/api.json
@@ -10165,6 +10165,18 @@
               "isoneof": false,
               "oneofdecl": "",
               "defaultValue": ""
+            },
+            {
+              "name": "band_id",
+              "description": "Optional Band ID to filter the results.",
+              "label": "",
+              "type": "string",
+              "longType": "string",
+              "fullType": "string",
+              "ismap": false,
+              "isoneof": false,
+              "oneofdecl": "",
+              "defaultValue": ""
             }
           ]
         },