chore: deprecate balance field

morremeyer · morremeyer · commit 8bdfc8b03eed · 2023-01-08T17:18:53.000+01:00
diff --git a/api/docs.go b/api/docs.go
@@ -2913,6 +2913,7 @@ const docTemplate = `{
             "type": "object",
             "properties": {
                 "balance": {
+                    "description": "DEPRECATED. Will be removed in API v2, see https://github.com/envelope-zero/backend/issues/526.",
                     "type": "number",
                     "example": 3423.42
                 },
diff --git a/api/swagger.json b/api/swagger.json
@@ -2901,6 +2901,7 @@
             "type": "object",
             "properties": {
                 "balance": {
+                    "description": "DEPRECATED. Will be removed in API v2, see https://github.com/envelope-zero/backend/issues/526.",
                     "type": "number",
                     "example": 3423.42
                 },
diff --git a/api/swagger.yaml b/api/swagger.yaml
@@ -139,6 +139,7 @@ definitions:
   controllers.Budget:
     properties:
       balance:
+        description: DEPRECATED. Will be removed in API v2, see https://github.com/envelope-zero/backend/issues/526.
         example: 3423.42
         type: number
       createdAt:
diff --git a/pkg/models/budget.go b/pkg/models/budget.go
@@ -16,7 +16,7 @@ import (
 type Budget struct {
 	DefaultModel
 	BudgetCreate
-	Balance decimal.Decimal `json:"balance" gorm:"-" example:"3423.42"`
+	Balance decimal.Decimal `json:"balance" gorm:"-" example:"3423.42"` // DEPRECATED. Will be removed in API v2, see https://github.com/envelope-zero/backend/issues/526.
 }
 
 type BudgetCreate struct {

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ import (`
`16`	`16`	`type Budget struct {`
`17`	`17`	`DefaultModel`
`18`	`18`	`BudgetCreate`
`19`		- Balance decimal.Decimal `json:"balance" gorm:"-" example:"3423.42"`
	`19`	+ Balance decimal.Decimal `json:"balance" gorm:"-" example:"3423.42"` // DEPRECATED. Will be removed in API v2, see https://github.com/envelope-zero/backend/issues/526.
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`type BudgetCreate struct {`