update field name for brick details endpoint

Author: mirkoCrobu

internal/api/docs/openapi.yaml

@@ -1319,15 +1319,15 @@ components:
             $ref: '#/components/schemas/CodeExample'
           nullable: true
           type: array
-        description:
-          type: string
-        id:
-          type: string
-        models:
+        compatible_models:
           items:
             $ref: '#/components/schemas/AIModel'
           nullable: true
           type: array
+        description:
+          type: string
+        id:
+          type: string
         name:
           type: string
         readme:
@@ -1353,6 +1353,7 @@ components:
         compatible_models:
           items:
             $ref: '#/components/schemas/AIModel'
+          nullable: true
           type: array
         config_variables:
           items:

internal/e2e/client/client.gen.go

@@ -144,7 +144,7 @@ func TestBricksDetails(t *testing.T) {
 		require.NotEmpty(t, *response.JSON200.Readme)
 		require.NotNil(t, response.JSON200.UsedByApps, "UsedByApps should not be nil")
 		require.Equal(t, expectedUsedByApps, *(response.JSON200.UsedByApps))
-		require.NotNil(t, response.JSON200.Models, "Models should not be nil")
-		require.Equal(t, expectedModelLiteInfo, *(response.JSON200.Models))
+		require.NotNil(t, response.JSON200.CompatibleModels, "Models should not be nil")
+		require.Equal(t, expectedModelLiteInfo, *(response.JSON200.CompatibleModels))
 	})
 }

internal/e2e/daemon/brick_test.go

@@ -209,7 +209,7 @@ func (s *Service) BricksDetails(id string, idProvider *app.IDProvider,
 		ApiDocsPath:  apiDocsPath,
 		CodeExamples: codeExamples,
 		UsedByApps:   usedByApps,
-		Models: f.Map(s.modelsIndex.GetModelsByBrick(brick.ID), func(m modelsindex.AIModel) AIModel {
+		CompatibleModels: f.Map(s.modelsIndex.GetModelsByBrick(brick.ID), func(m modelsindex.AIModel) AIModel {
 			return AIModel{
 				ID:          m.ID,
 				Name:        m.Name,

internal/orchestrator/bricks/bricks.go

@@ -418,13 +418,13 @@ func TestBricksDetails(t *testing.T) {
 		require.Len(t, res.UsedByApps, 1)
 		require.Equal(t, "My App", res.UsedByApps[0].Name)
 		require.NotEmpty(t, res.UsedByApps[0].ID)
-		require.Len(t, res.Models, 2)
-		require.Equal(t, "yolox-object-detection", res.Models[0].ID)
-		require.Equal(t, "General purpose object detection - YoloX", res.Models[0].Name)
-		require.Equal(t, "General purpose object detection...", res.Models[0].Description)
-		require.Equal(t, "face-detection", res.Models[1].ID)
-		require.Equal(t, "Lightweight-Face-Detection", res.Models[1].Name)
-		require.Equal(t, "", res.Models[1].Description)
+		require.Len(t, res.CompatibleModels, 2)
+		require.Equal(t, "yolox-object-detection", res.CompatibleModels[0].ID)
+		require.Equal(t, "General purpose object detection - YoloX", res.CompatibleModels[0].Name)
+		require.Equal(t, "General purpose object detection...", res.CompatibleModels[0].Description)
+		require.Equal(t, "face-detection", res.CompatibleModels[1].ID)
+		require.Equal(t, "Lightweight-Face-Detection", res.CompatibleModels[1].Name)
+		require.Equal(t, "", res.CompatibleModels[1].Description)
 	})
 
 	t.Run("Success - Full Details - no models", func(t *testing.T) {
@@ -443,7 +443,7 @@ func TestBricksDetails(t *testing.T) {
 		require.Len(t, res.UsedByApps, 1)
 		require.Equal(t, "My App", res.UsedByApps[0].Name)
 		require.NotEmpty(t, res.UsedByApps[0].ID)
-		require.Len(t, res.Models, 0)
+		require.Len(t, res.CompatibleModels, 0)
 	})
 
 	t.Run("Success - Full Details - one model", func(t *testing.T) {
@@ -452,10 +452,10 @@ func TestBricksDetails(t *testing.T) {
 
 		require.Equal(t, "arduino:one_model_brick", res.ID)
 		require.Equal(t, "one model brick", res.Name)
-		require.Len(t, res.Models, 1)
-		require.Equal(t, "face-detection", res.Models[0].ID)
-		require.Equal(t, "Lightweight-Face-Detection", res.Models[0].Name)
-		require.Equal(t, "", res.Models[0].Description)
+		require.Len(t, res.CompatibleModels, 1)
+		require.Equal(t, "face-detection", res.CompatibleModels[0].ID)
+		require.Equal(t, "Lightweight-Face-Detection", res.CompatibleModels[0].Name)
+		require.Equal(t, "", res.CompatibleModels[0].Description)
 	})
 }
 

internal/orchestrator/bricks/bricks_test.go

@@ -72,16 +72,16 @@ type AppReference struct {
 }
 
 type BrickDetailsResult struct {
-	ID           string                   `json:"id"`
-	Name         string                   `json:"name"`
-	Author       string                   `json:"author"`
-	Description  string                   `json:"description"`
-	Category     string                   `json:"category"`
-	Status       string                   `json:"status"`
-	Variables    map[string]BrickVariable `json:"variables,omitempty"`
-	Readme       string                   `json:"readme"`
-	ApiDocsPath  string                   `json:"api_docs_path"`
-	CodeExamples []CodeExample            `json:"code_examples"`
-	UsedByApps   []AppReference           `json:"used_by_apps"`
-	Models       []AIModel                `json:"models"`
+	ID               string                   `json:"id"`
+	Name             string                   `json:"name"`
+	Author           string                   `json:"author"`
+	Description      string                   `json:"description"`
+	Category         string                   `json:"category"`
+	Status           string                   `json:"status"`
+	Variables        map[string]BrickVariable `json:"variables,omitempty"`
+	Readme           string                   `json:"readme"`
+	ApiDocsPath      string                   `json:"api_docs_path"`
+	CodeExamples     []CodeExample            `json:"code_examples"`
+	UsedByApps       []AppReference           `json:"used_by_apps"`
+	CompatibleModels []AIModel                `json:"compatible_models"`
 }