dr: Update api definition and translations

CHANGELOG.md

@@ -15,6 +15,7 @@ For details about compatibility between different releases, see the **Commitment
   - `ListFrequencyPlans` RPC has a new `gateways-only` flag.
 - Option to pause application webhooks.
 - Endpoint for claiming gateways using a qr code
+- Update the GetTemplate endpoint in device repository to check for profile identifiers in the vendor index.
 
 ### Changed
 

config/messages.json

@@ -4121,7 +4121,7 @@
       "file": "store.go"
     }
   },
-  "error:pkg/devicerepository/store/bleve:missing_profile_identifier": {
+  "error:pkg/devicerepository/store/bleve:missing_profile_identifiers": {
     "translations": {
       "en": "both vendor ID and vendor profile ID must be provided"
     },
@@ -4130,24 +4130,6 @@
       "file": "store.go"
     }
   },
-  "error:pkg/devicerepository/store/bleve:multiple_identifiers": {
-    "translations": {
-      "en": "multiple identifiers found in the request. Use either EndDeviceVersionIdentifiers or EndDeviceProfileIdentifiers"
-    },
-    "description": {
-      "package": "pkg/devicerepository/store/bleve",
-      "file": "store.go"
-    }
-  },
-  "error:pkg/devicerepository/store/bleve:no_identifiers": {
-    "translations": {
-      "en": "no identifiers provided"
-    },
-    "description": {
-      "package": "pkg/devicerepository/store/bleve",
-      "file": "store.go"
-    }
-  },
   "error:pkg/devicerepository/store/remote:band_not_found": {
     "translations": {
       "en": "band `{band_id}` not found"
@@ -4193,6 +4175,15 @@
       "file": "remote.go"
     }
   },
+  "error:pkg/devicerepository/store/remote:missing_profile_identifiers": {
+    "translations": {
+      "en": "both vendor ID and vendor profile ID must be provided"
+    },
+    "description": {
+      "package": "pkg/devicerepository/store/remote",
+      "file": "remote.go"
+    }
+  },
   "error:pkg/devicerepository/store/remote:model_not_found": {
     "translations": {
       "en": "model `{brand_id}/{model_id}` not found"

pkg/devicerepository/store/bleve/bleve.go

@@ -31,12 +31,12 @@ import (
 )
 
 const (
-	// Timeout for opening the index. This is to avoid blocking on the index
+	// DefaultTimeout for opening the index. This is to avoid blocking on the index
 	// open call, which hangs indefinitely if the index is already in use by
 	// a different process.
 	defaultTimeout = 5 * time.Second
 
-	// Size of the cache for brands and models.
+	// CacheSize for brands and models.
 	cacheSize = 1024
 )
 

pkg/devicerepository/store/bleve/bleve_test.go

@@ -462,7 +462,7 @@ func TestBleve(t *testing.T) {
 				Name: "ZeroProfileID",
 				Req: &ttnpb.GetTemplateRequest{
 					EndDeviceProfileIds: &ttnpb.GetTemplateRequest_EndDeviceProfileIdentifiers{
-						VendorId: 42, // why is it allowed to have a vendor ID but no profile ID?
+						VendorId: 42,
 					},
 				},
 				Assertion: func(t *ttnpb.EndDeviceTemplate, err error) bool {

pkg/devicerepository/store/bleve/store.go

@@ -36,14 +36,14 @@ var (
 		"invalid_number_of_profiles",
 		"invalid number of profiles returned",
 	)
-	errMultipleIdentifiers = errors.DefineCorruption(
-		"multiple_identifiers",
-		"multiple identifiers found in the request. Use either EndDeviceVersionIdentifiers or EndDeviceProfileIdentifiers",
-	)
 	errEndDeviceProfileNotFound = errors.DefineNotFound(
 		"end_device_profile_not_found",
 		"end device profile not found for vendor ID `{vendor_id}` and vendor profile ID `{vendor_profile_id}`",
 	)
+	errMissingProfileIdentifiers = errors.DefineInvalidArgument(
+		"missing_profile_identifiers",
+		"both vendor ID and vendor profile ID must be provided",
+	)
 )
 
 // retrieve returns the resulting document from the cache, if available. Otherwise,
@@ -195,75 +195,56 @@ func (s *bleveStore) GetModels(req store.GetModelsRequest) (*store.GetModelsResp
 	}, nil
 }
 
-var (
-	errNoIdentifiers = errors.DefineInvalidArgument(
-		"no_identifiers",
-		"no identifiers provided",
-	)
-	errMissingProfileIdentifier = errors.DefineInvalidArgument(
-		"missing_profile_identifier",
-		"both vendor ID and vendor profile ID must be provided",
-	)
-)
-
 // GetTemplate retrieves an end device template for an end device definition.
 func (s *bleveStore) GetTemplate(req *ttnpb.GetTemplateRequest) (*ttnpb.EndDeviceTemplate, error) {
-	profileIDs, versionIDs := req.GetEndDeviceProfileIds(), req.GetVersionIds()
-	if profileIDs == nil && versionIDs == nil {
-		return nil, errNoIdentifiers.New()
+	profileIDs := req.GetEndDeviceProfileIds()
+	if profileIDs == nil {
+		return s.store.GetTemplate(req)
 	}
-	if profileIDs != nil && versionIDs != nil {
-		return nil, errMultipleIdentifiers.New()
+	if profileIDs.VendorId == 0 || profileIDs.VendorProfileId == 0 {
+		return nil, errMissingProfileIdentifiers.New()
 	}
+	documentTypeQuery := bleve.NewTermQuery(templateDocumentType)
+	documentTypeQuery.SetField("Type")
+	queries := []query.Query{documentTypeQuery}
 
-	if profileIDs != nil {
-		if profileIDs.VendorId == 0 || profileIDs.VendorProfileId == 0 {
-			return nil, errMissingProfileIdentifier.New()
-		}
-		documentTypeQuery := bleve.NewTermQuery(templateDocumentType)
-		documentTypeQuery.SetField("Type")
-		queries := []query.Query{documentTypeQuery}
-
-		queryTerm := bleve.NewTermQuery(strconv.Itoa(int(profileIDs.VendorId)))
-		queryTerm.SetField("VendorID")
-		queries = append(queries, queryTerm)
+	queryTerm := bleve.NewTermQuery(strconv.Itoa(int(profileIDs.VendorId)))
+	queryTerm.SetField("VendorID")
+	queries = append(queries, queryTerm)
 
-		queryTerm = bleve.NewTermQuery(strconv.Itoa(int(profileIDs.VendorProfileId)))
-		queryTerm.SetField("VendorProfileID")
-		queries = append(queries, queryTerm)
-
-		searchRequest := bleve.NewSearchRequest(bleve.NewConjunctionQuery(queries...))
-		searchRequest.Fields = []string{"TemplateJSON"}
-		result, err := s.index.Search(searchRequest)
-		if err != nil {
-			return nil, err
-		}
+	queryTerm = bleve.NewTermQuery(strconv.Itoa(int(profileIDs.VendorProfileId)))
+	queryTerm.SetField("VendorProfileID")
+	queries = append(queries, queryTerm)
 
-		if len(result.Hits) == 0 {
-			return nil, errEndDeviceProfileNotFound.WithAttributes(
-				"vendor_id", profileIDs.VendorId,
-				"vendor_profile_id", profileIDs.VendorProfileId)
-		}
+	searchRequest := bleve.NewSearchRequest(bleve.NewConjunctionQuery(queries...))
+	searchRequest.Fields = []string{"TemplateJSON"}
+	result, err := s.index.Search(searchRequest)
+	if err != nil {
+		return nil, err
+	}
 
-		if len(result.Hits) != 1 {
-			// There can only be one profile for a given tuple.
-			return nil, errInvalidNumberOfProfiles.New()
-		}
+	if len(result.Hits) == 0 {
+		return nil, errEndDeviceProfileNotFound.WithAttributes(
+			"vendor_id", profileIDs.VendorId,
+			"vendor_profile_id", profileIDs.VendorProfileId)
+	}
 
-		hit, err := s.retrieve(result.Hits[0], "TemplateJSON", func() any { return &ttnpb.EndDeviceTemplate{} })
-		if err != nil {
-			return nil, err
-		}
+	if len(result.Hits) != 1 {
+		// There can only be one profile for a given tuple.
+		return nil, errInvalidNumberOfProfiles.New()
+	}
 
-		template, ok := hit.(*ttnpb.EndDeviceTemplate)
-		if !ok {
-			return nil, errCorruptedIndex.New()
-		}
+	hit, err := s.retrieve(result.Hits[0], "TemplateJSON", func() any { return &ttnpb.EndDeviceTemplate{} })
+	if err != nil {
+		return nil, err
+	}
 
-		return template, nil
+	template, ok := hit.(*ttnpb.EndDeviceTemplate)
+	if !ok {
+		return nil, errCorruptedIndex.New()
 	}
 
-	return s.store.GetTemplate(req)
+	return template, nil
 }
 
 // GetUplinkDecoder retrieves the codec for decoding uplink messages.

pkg/devicerepository/store/remote/remote.go

@@ -341,7 +341,12 @@ var (
 	)
 	errBandNotFoundForRegion = errors.DefineNotFound(
 		"band_not_found_for_region",
-		"band not found for region `{region}`")
+		"band not found for region `{region}`",
+	)
+	errMissingProfileIdentifiers = errors.DefineInvalidArgument(
+		"missing_profile_identifiers",
+		"both vendor ID and vendor profile ID must be provided",
+	)
 )
 
 // GetTemplate retrieves an end device template for an end device definition.
@@ -414,15 +419,16 @@ func (s *remoteStore) getVersionIDsUsingProfileIDs(
 	ids *ttnpb.GetTemplateRequest_EndDeviceProfileIdentifiers,
 ) (*ttnpb.EndDeviceVersionIdentifiers, error) {
 	if ids.VendorProfileId == 0 || ids.VendorId == 0 {
-		return nil, errors.New("vendor_profile_id and vendor_id must be set")
+		return nil, errMissingProfileIdentifiers.New()
 	}
 
 	brandID, err := s.getBrandIDByVendorID(ids.VendorId)
 	if err != nil {
 		return nil, errBrandWithVendorIDNotFound.WithAttributes("vendor_id", ids.VendorId)
 	}
 	endDeviceProfilesIdentifiers, err := s.GetEndDeviceProfileIdentifiers(
-		store.GetEndDeviceProfileIdentifiersRequest{BrandID: brandID})
+		store.GetEndDeviceProfileIdentifiersRequest{BrandID: brandID},
+	)
 	if err != nil {
 		return nil, err
 	}