qrg: Update parse gateway qr response

TheThingsNetwork · Sep 9, 2024 · 281d218 · 281d218
1 parent c1bd09a
commit 281d218
Show file tree

Hide file tree

Showing 11 changed files with 313 additions and 256 deletions.
diff --git a/api/ttn/lorawan/v3/api.md b/api/ttn/lorawan/v3/api.md
@@ -10564,7 +10564,15 @@ The Pba service allows clients to manage peering through Packet Broker.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | `format_id` | [`string`](#string) |  | Identifier of the format used to successfully parse the QR code data. |
-| `claim_gateway_request` | [`ClaimGatewayRequest`](#ttn.lorawan.v3.ClaimGatewayRequest) |  |  |
+| `gateway_eui` | [`bytes`](#bytes) |  |  |
+| `owner_token` | [`string`](#string) |  |  |
+
+#### Field Rules
+
+| Field | Validations |
+| ----- | ----------- |
+| `gateway_eui` | <p>`bytes.len`: `8`</p> |
+| `owner_token` | <p>`string.pattern`: `^[A-Z0-9]{1,32}$`</p> |
 
 ### <a name="ttn.lorawan.v3.QRCodeFormat">Message `QRCodeFormat`</a>
 

diff --git a/api/ttn/lorawan/v3/api.swagger.json b/api/ttn/lorawan/v3/api.swagger.json
@@ -28060,8 +28060,13 @@
           "type": "string",
           "description": "Identifier of the format used to successfully parse the QR code data."
         },
-        "claim_gateway_request": {
-          "$ref": "#/definitions/v3ClaimGatewayRequest"
+        "gateway_eui": {
+          "type": "string",
+          "format": "string",
+          "example": "70B3D57ED000ABCD"
+        },
+        "owner_token": {
+          "type": "string"
         }
       }
     },

diff --git a/api/ttn/lorawan/v3/qrcodegenerator.proto b/api/ttn/lorawan/v3/qrcodegenerator.proto
@@ -20,7 +20,7 @@ import "google/api/annotations.proto";
 import "google/protobuf/empty.proto";
 import "google/protobuf/field_mask.proto";
 import "protoc-gen-openapiv2/options/annotations.proto";
-import "ttn/lorawan/v3/deviceclaimingserver.proto";
+import "thethings/json/annotations.proto";
 import "ttn/lorawan/v3/end_device.proto";
 import "ttn/lorawan/v3/picture.proto";
 import "validate/validate.proto";
@@ -149,7 +149,22 @@ message ParseGatewayQRCodeRequest {
 message ParseGatewayQRCodeResponse {
   // Identifier of the format used to successfully parse the QR code data.
   string format_id = 1;
-  ClaimGatewayRequest claim_gateway_request = 2;
+  bytes gateway_eui = 2 [
+    (validate.rules).bytes = {
+      len: 8,
+      ignore_empty: true
+    },
+    (thethings.json.field) = {
+      marshaler_func: "go.thethings.network/lorawan-stack/v3/pkg/types.MarshalHEXBytes",
+      unmarshaler_func: "go.thethings.network/lorawan-stack/v3/pkg/types.Unmarshal8Bytes"
+    },
+    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+      type: STRING,
+      format: "string",
+      example: "\"70B3D57ED000ABCD\""
+    }
+  ];
+  string owner_token = 3 [(validate.rules).string.pattern = "^[A-Z0-9]{1,32}$"];
 }
 
 // The GatewayQRCodeGenerator service provides functionality to generate and parse QR codes for gateways.

diff --git a/pkg/qrcodegenerator/grpc_gateways.go b/pkg/qrcodegenerator/grpc_gateways.go
@@ -59,14 +59,8 @@ func (s *gatewayQRCodeGeneratorServer) Parse(
 	}
 
 	return &ttnpb.ParseGatewayQRCodeResponse{
-		FormatId: data.FormatID(),
-		ClaimGatewayRequest: &ttnpb.ClaimGatewayRequest{
-			SourceGateway: &ttnpb.ClaimGatewayRequest_AuthenticatedIdentifiers_{
-				AuthenticatedIdentifiers: &ttnpb.ClaimGatewayRequest_AuthenticatedIdentifiers{
-					GatewayEui:         data.GatewayEUI().Bytes(),
-					AuthenticationCode: []byte(data.OwnerToken()),
-				},
-			},
-		},
+		FormatId:   data.FormatID(),
+		GatewayEui: data.GatewayEUI().Bytes(),
+		OwnerToken: data.OwnerToken(),
 	}, nil
 }
diff --git a/pkg/qrcodegenerator/grpc_gateways_test.go b/pkg/qrcodegenerator/grpc_gateways_test.go
@@ -117,6 +117,8 @@ func TestGatewayQRCodeParsing(t *testing.T) {
 					return false
 				}
 				a.So(resp.FormatId, should.Equal, ttigpro1.ID())
+				a.So(resp.GatewayEui, should.Resemble, []uint8{0xec, 0x65, 0x6e, 0xff, 0xfe, 0x00, 0x01, 0x28})
+				a.So(resp.OwnerToken, should.Equal, "abcdef123456")
 
 				return true
 			},

diff --git a/pkg/ttnpb/qrcodegenerator.pb.go b/pkg/ttnpb/qrcodegenerator.pb.go
diff --git a/pkg/ttnpb/qrcodegenerator.pb.paths.fm.go b/pkg/ttnpb/qrcodegenerator.pb.paths.fm.go
diff --git a/pkg/ttnpb/qrcodegenerator.pb.setters.fm.go b/pkg/ttnpb/qrcodegenerator.pb.setters.fm.go
diff --git a/pkg/ttnpb/qrcodegenerator.pb.validate.go b/pkg/ttnpb/qrcodegenerator.pb.validate.go
diff --git a/pkg/ttnpb/qrcodegenerator_json.pb.go b/pkg/ttnpb/qrcodegenerator_json.pb.go
diff --git a/sdk/js/generated/api.json b/sdk/js/generated/api.json
@@ -48337,16 +48337,44 @@
               "defaultValue": ""
             },
             {
-              "name": "claim_gateway_request",
+              "name": "gateway_eui",
               "description": "",
               "label": "",
-              "type": "ClaimGatewayRequest",
-              "longType": "ClaimGatewayRequest",
-              "fullType": "ttn.lorawan.v3.ClaimGatewayRequest",
+              "type": "bytes",
+              "longType": "bytes",
+              "fullType": "bytes",
               "ismap": false,
               "isoneof": false,
               "oneofdecl": "",
-              "defaultValue": ""
+              "defaultValue": "",
+              "options": {
+                "validate.rules": [
+                  {
+                    "name": "bytes.len",
+                    "value": 8
+                  }
+                ]
+              }
+            },
+            {
+              "name": "owner_token",
+              "description": "",
+              "label": "",
+              "type": "string",
+              "longType": "string",
+              "fullType": "string",
+              "ismap": false,
+              "isoneof": false,
+              "oneofdecl": "",
+              "defaultValue": "",
+              "options": {
+                "validate.rules": [
+                  {
+                    "name": "string.pattern",
+                    "value": "^[A-Z0-9]{1,32}$"
+                  }
+                ]
+              }
             }
           ]
         },