feat: always return all fields (#234)

This makes interaction with the API easier since users can
rely on all fields being returned all the time, showing
all possible fields to set.

Author: morremeyer

pkg/models/account.go

@@ -17,8 +17,8 @@ type Account struct {
 }
 
 type AccountCreate struct {
-	Name     string    `json:"name,omitempty" example:"Cash" default:""`
-	Note     string    `json:"note,omitempty" example:"Money in my wallet" default:""`
+	Name     string    `json:"name" example:"Cash" default:""`
+	Note     string    `json:"note" example:"Money in my wallet" default:""`
 	BudgetID uuid.UUID `json:"budgetId" example:"550dc009-cea6-4c12-b2a5-03446eb7b7cf"`
 	OnBudget bool      `json:"onBudget" example:"true" default:"false"` // Always false when external: true
 	External bool      `json:"external" example:"false" default:"false"`

pkg/models/allocation.go

@@ -16,5 +16,5 @@ type AllocationCreate struct {
 	Month      uint8           `json:"month" gorm:"uniqueIndex:year_month;check:month_valid,month >= 1 AND month <= 12" minimum:"1" maximum:"12" example:"6"`
 	Year       uint            `json:"year" gorm:"uniqueIndex:year_month" example:"2022"`
 	Amount     decimal.Decimal `json:"amount" gorm:"type:DECIMAL(20,8)" example:"22.01" minimum:"0.00000001" maximum:"999999999999.99999999" multipleOf:"0.00000001"` // The maximum value is "999999999999.99999999", swagger unfortunately rounds this.
-	EnvelopeID uuid.UUID       `json:"envelopeId,omitempty" example:"a0909e84-e8f9-4cb6-82a5-025dff105ff2"`
+	EnvelopeID uuid.UUID       `json:"envelopeId" example:"a0909e84-e8f9-4cb6-82a5-025dff105ff2"`
 }

pkg/models/budget.go

@@ -18,14 +18,14 @@ type Budget struct {
 }
 
 type BudgetCreate struct {
-	Name     string `json:"name,omitempty" example:"Morre's Budget" default:""`
-	Note     string `json:"note,omitempty" example:"My personal expenses" default:""`
-	Currency string `json:"currency,omitempty" example:"€" default:""`
+	Name     string `json:"name" example:"Morre's Budget" default:""`
+	Note     string `json:"note" example:"My personal expenses" default:""`
+	Currency string `json:"currency" example:"€" default:""`
 }
 
 type BudgetMonth struct {
 	ID        uuid.UUID       `json:"id" example:"1e777d24-3f5b-4c43-8000-04f65f895578"` // The ID of the Envelope
 	Name      string          `json:"name" example:"Groceries"`                          // The name of the Envelope
 	Month     time.Time       `json:"month" example:"2006-05-01T00:00:00.000000Z"`       // This is always set to 00:00 UTC on the first of the month.
-	Envelopes []EnvelopeMonth `json:"envelopes,omitempty"`
+	Envelopes []EnvelopeMonth `json:"envelopes"`
 }

pkg/models/category.go

@@ -10,7 +10,7 @@ type Category struct {
 }
 
 type CategoryCreate struct {
-	Name     string    `json:"name,omitempty" example:"Saving" default:""`
+	Name     string    `json:"name" example:"Saving" default:""`
 	BudgetID uuid.UUID `json:"budgetId" example:"52d967d3-33f4-4b04-9ba7-772e5ab9d0ce"`
-	Note     string    `json:"note,omitempty" example:"All envelopes for long-term saving" default:""`
+	Note     string    `json:"note" example:"All envelopes for long-term saving" default:""`
 }

pkg/models/envelope.go

@@ -16,9 +16,9 @@ type Envelope struct {
 }
 
 type EnvelopeCreate struct {
-	Name       string    `json:"name,omitempty" example:"Groceries" default:""`
+	Name       string    `json:"name" example:"Groceries" default:""`
 	CategoryID uuid.UUID `json:"categoryId" example:"878c831f-af99-4a71-b3ca-80deb7d793c1"`
-	Note       string    `json:"note,omitempty" example:"For stuff bought at supermarkets and drugstores" default:""`
+	Note       string    `json:"note" example:"For stuff bought at supermarkets and drugstores" default:""`
 }
 
 // EnvelopeMonth contains data about an Envelope for a specific month.

pkg/models/model.go

@@ -12,7 +12,7 @@ type Model struct {
 	ID        uuid.UUID       `json:"id" example:"65392deb-5e92-4268-b114-297faad6cdce"`
 	CreatedAt time.Time       `json:"createdAt" example:"2022-04-02T19:28:44.491514Z"`
 	UpdatedAt time.Time       `json:"updatedAt" example:"2022-04-17T20:14:01.048145Z"`
-	DeletedAt *gorm.DeletedAt `json:"deletedAt,omitempty" gorm:"index" example:"2022-04-22T21:01:05.058161Z" swaggertype:"primitive,string"`
+	DeletedAt *gorm.DeletedAt `json:"deletedAt" gorm:"index" example:"2022-04-22T21:01:05.058161Z" swaggertype:"primitive,string"`
 }
 
 // AfterFind updates the timestamps to use UTC as

pkg/models/transaction.go

@@ -19,13 +19,13 @@ type Transaction struct {
 }
 
 type TransactionCreate struct {
-	Date                 time.Time       `json:"date,omitempty" example:"1815-12-10T18:43:00.271152Z"`
+	Date                 time.Time       `json:"date" example:"1815-12-10T18:43:00.271152Z"`
 	Amount               decimal.Decimal `json:"amount" gorm:"type:DECIMAL(20,8)" example:"14.03" minimum:"0.00000001" maximum:"999999999999.99999999" multipleOf:"0.00000001"` // The maximum value is "999999999999.99999999", swagger unfortunately rounds this.
-	Note                 string          `json:"note,omitempty" example:"Lunch" default:""`
-	BudgetID             uuid.UUID       `json:"budgetId,omitempty" example:"55eecbd8-7c46-4b06-ada9-f287802fb05e"`
-	SourceAccountID      uuid.UUID       `json:"sourceAccountId,omitempty" example:"fd81dc45-a3a2-468e-a6fa-b2618f30aa45"`
-	DestinationAccountID uuid.UUID       `json:"destinationAccountId,omitempty" example:"8e16b456-a719-48ce-9fec-e115cfa7cbcc"`
-	EnvelopeID           uuid.UUID       `json:"envelopeId,omitempty" example:"2649c965-7999-4873-ae16-89d5d5fa972e"`
+	Note                 string          `json:"note" example:"Lunch" default:""`
+	BudgetID             uuid.UUID       `json:"budgetId" example:"55eecbd8-7c46-4b06-ada9-f287802fb05e"`
+	SourceAccountID      uuid.UUID       `json:"sourceAccountId" example:"fd81dc45-a3a2-468e-a6fa-b2618f30aa45"`
+	DestinationAccountID uuid.UUID       `json:"destinationAccountId" example:"8e16b456-a719-48ce-9fec-e115cfa7cbcc"`
+	EnvelopeID           uuid.UUID       `json:"envelopeId" example:"2649c965-7999-4873-ae16-89d5d5fa972e"`
 	Reconciled           bool            `json:"reconciled" example:"true" default:"false"`
 }