add deprecated field description for openapi

mirkoCrobu · mirkoCrobu · commit 08822e9a9dea · 2025-11-04T12:32:17.000+01:00
diff --git a/internal/api/docs/openapi.yaml b/internal/api/docs/openapi.yaml
@@ -1336,6 +1336,8 @@ components:
         variables:
           additionalProperties:
             type: string
+          description: 'Deprecated: use variables_details instead. This field is kept
+            for backward compatibility.'
           type: object
         variables_details:
           items:
diff --git a/internal/e2e/client/client.gen.go b/internal/e2e/client/client.gen.go
diff --git a/internal/orchestrator/bricks/types.go b/internal/orchestrator/bricks/types.go
@@ -39,7 +39,7 @@ type BrickInstance struct {
 	Author           string                  `json:"author"`
 	Category         string                  `json:"category"`
 	Status           string                  `json:"status"`
-	Variables        map[string]string       `json:"variables,omitempty"`
+	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"`
 }

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ type BrickInstance struct {`
`39`	`39`	Author string `json:"author"`
`40`	`40`	Category string `json:"category"`
`41`	`41`	Status string `json:"status"`
`42`		- Variables map[string]string `json:"variables,omitempty"`
	`42`	+ Variables map[string]string `json:"variables,omitempty" description:"Deprecated: use variables_details instead. This field is kept for backward compatibility."`
`43`	`43`	VariablesDetails []BrickInstanceVariable `json:"variables_details,omitempty"`
`44`	`44`	ModelID string `json:"model,omitempty"`
`45`	`45`	`}`