rename variables_details to config_variables

Author: mirkoCrobu

internal/api/docs/openapi.yaml

@@ -1325,6 +1325,10 @@ components:
           type: string
         category:
           type: string
+        config_variables:
+          items:
+            $ref: '#/components/schemas/BrickInstanceVariable'
+          type: array
         id:
           type: string
         model:
@@ -1336,13 +1340,9 @@ components:
         variables:
           additionalProperties:
             type: string
-          description: 'Deprecated: use variables_details instead. This field is kept
+          description: 'Deprecated: use config_variables instead. This field is kept
             for backward compatibility.'
           type: object
-        variables_details:
-          items:
-            $ref: '#/components/schemas/BrickInstanceVariable'
-          type: array
       type: object
     BrickInstanceVariable:
       properties:

internal/e2e/client/client.gen.go

@@ -37,7 +37,7 @@ const (
 )
 
 var (
-	expectedVariablesDetails = []client.BrickInstanceVariable{
+	expectedConfigVariables = []client.BrickInstanceVariable{
 		{
 			Description: f.Ptr("path to the custom model directory"),
 			Name:        f.Ptr("CUSTOM_MODEL_PATH"),
@@ -90,7 +90,7 @@ func TestGetAppBrickInstances(t *testing.T) {
 		require.NoError(t, err)
 		require.Len(t, *brickInstances.JSON200.Bricks, 1)
 		require.Equal(t, ImageClassifactionBrickID, *(*brickInstances.JSON200.Bricks)[0].Id)
-		require.Equal(t, expectedVariablesDetails, *(*brickInstances.JSON200.Bricks)[0].VariablesDetails)
+		require.Equal(t, expectedConfigVariables, *(*brickInstances.JSON200.Bricks)[0].ConfigVariables)
 
 	})
 
@@ -134,7 +134,7 @@ func TestGetAppBrickInstanceById(t *testing.T) {
 		require.NoError(t, err)
 		require.NotEmpty(t, brickInstance.JSON200)
 		require.Equal(t, ImageClassifactionBrickID, *brickInstance.JSON200.Id)
-		require.Equal(t, expectedVariablesDetails, (*brickInstance.JSON200.VariablesDetails))
+		require.Equal(t, expectedConfigVariables, (*brickInstance.JSON200.ConfigVariables))
 	})
 
 	t.Run("GetAppBrickInstanceByBrickID_InvalidAppID_Fails", func(t *testing.T) {

internal/e2e/daemon/instance_bricks_test.go

@@ -80,17 +80,17 @@ func (s *Service) AppBrickInstancesList(a *app.ArduinoApp) (AppBrickInstancesRes
 			return AppBrickInstancesResult{}, fmt.Errorf("brick not found with id %s", brickInstance.ID)
 		}
 
-		variablesMap, instanceVariables := getBrickVariableDetails(brick, brickInstance.Variables)
+		variablesMap, instanceVariables := getBrickConfigDetails(brick, brickInstance.Variables)
 
 		res.BrickInstances[i] = BrickInstance{
-			ID:               brick.ID,
-			Name:             brick.Name,
-			Author:           "Arduino", // TODO: for now we only support our bricks
-			Category:         brick.Category,
-			Status:           "installed",
-			ModelID:          brickInstance.Model, // TODO: in case is not set by the user, should we return the default model?
-			Variables:        variablesMap,        // TODO: do we want to show also the default value of not explicitly set variables?
-			VariablesDetails: instanceVariables,
+			ID:              brick.ID,
+			Name:            brick.Name,
+			Author:          "Arduino", // TODO: for now we only support our bricks
+			Category:        brick.Category,
+			Status:          "installed",
+			ModelID:         brickInstance.Model, // TODO: in case is not set by the user, should we return the default model?
+			Variables:       variablesMap,        // TODO: do we want to show also the default value of not explicitly set variables?
+			ConfigVariables: instanceVariables,
 		}
 
 	}
@@ -108,26 +108,26 @@ func (s *Service) AppBrickInstanceDetails(a *app.ArduinoApp, brickID string) (Br
 		return BrickInstance{}, fmt.Errorf("brick %s not added in the app", brickID)
 	}
 
-	variables, instanceVariables := getBrickVariableDetails(brick, a.Descriptor.Bricks[brickIndex].Variables)
+	variables, instanceVariables := getBrickConfigDetails(brick, a.Descriptor.Bricks[brickIndex].Variables)
 
 	modelID := a.Descriptor.Bricks[brickIndex].Model
 	if modelID == "" {
 		modelID = brick.ModelName
 	}
 
 	return BrickInstance{
-		ID:               brickID,
-		Name:             brick.Name,
-		Author:           "Arduino", // TODO: for now we only support our bricks
-		Category:         brick.Category,
-		Status:           "installed", // For now every Arduino brick are installed
-		Variables:        variables,
-		VariablesDetails: instanceVariables,
-		ModelID:          modelID,
+		ID:              brickID,
+		Name:            brick.Name,
+		Author:          "Arduino", // TODO: for now we only support our bricks
+		Category:        brick.Category,
+		Status:          "installed", // For now every Arduino brick are installed
+		Variables:       variables,
+		ConfigVariables: instanceVariables,
+		ModelID:         modelID,
 	}, nil
 }
 
-func getBrickVariableDetails(
+func getBrickConfigDetails(
 	brick *bricksindex.Brick, userVariables map[string]string,
 ) (map[string]string, []BrickInstanceVariable) {
 	variablesMap := make(map[string]string, len(brick.Variables))

internal/orchestrator/bricks/bricks.go

@@ -184,7 +184,7 @@ func TestGetBrickInstanceVariableDetails(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			actualVariableMap, actualInstanceVariables := getBrickVariableDetails(tt.brick, tt.userVariables)
+			actualVariableMap, actualInstanceVariables := getBrickConfigDetails(tt.brick, tt.userVariables)
 			require.Equal(t, tt.expectedVariableMap, actualVariableMap)
 			require.Equal(t, tt.expectedInstanceVariable, actualInstanceVariables)
 		})

internal/orchestrator/bricks/bricks_test.go

@@ -34,14 +34,14 @@ type AppBrickInstancesResult struct {
 }
 
 type BrickInstance struct {
-	ID               string                  `json:"id"`
-	Name             string                  `json:"name"`
-	Author           string                  `json:"author"`
-	Category         string                  `json:"category"`
-	Status           string                  `json:"status"`
-	Variables        map[string]string       `json:"variables,omitempty" description:"Deprecated: use variables_details instead. This field is kept for backward compatibility."`
-	VariablesDetails []BrickInstanceVariable `json:"variables_details,omitempty"`
-	ModelID          string                  `json:"model,omitempty"`
+	ID              string                  `json:"id"`
+	Name            string                  `json:"name"`
+	Author          string                  `json:"author"`
+	Category        string                  `json:"category"`
+	Status          string                  `json:"status"`
+	Variables       map[string]string       `json:"variables,omitempty" description:"Deprecated: use config_variables instead. This field is kept for backward compatibility."`
+	ConfigVariables []BrickInstanceVariable `json:"config_variables,omitempty"`
+	ModelID         string                  `json:"model,omitempty"`
 }
 
 type BrickInstanceVariable struct {