addressed review

GenerateNU · Jan 21, 2024 · bff3a71 · bff3a71
1 parent 1c282bd
commit bff3a71
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 8 deletions.
diff --git a/backend/src/controllers/tag.go b/backend/src/controllers/tag.go
@@ -78,6 +78,11 @@ func (t *TagController) GetTag(c *fiber.Ctx) error {
 // @Param		id	path	int	true	"Tag ID"
 // @Success		204
 // @Failure     400   {string}    string "failed to process the request"
+// @Failure     400   {string}    string "failed to validate id"
+// @Failure     400   {string}    string "failed to validate the data"
+// @Failure     404   {string}    string "failed to find tag"
+// @Failure     500   {string}    string "failed to update tag"
+// @Router		/api/v1/tags/{id}  [patch]
 func (t *TagController) UpdateTag(c *fiber.Ctx) error {
 	var tagBody models.UpdateTagRequestBody
 

diff --git a/backend/src/services/tag.go b/backend/src/services/tag.go
@@ -9,20 +9,20 @@ import (
 )
 
 type TagServiceInterface interface {
-	CreateTag(partialTag models.CreateTagRequestBody) (*models.Tag, error)
+	CreateTag(tagBody models.CreateTagRequestBody) (*models.Tag, error)
 	GetTag(id string) (*models.Tag, error)
-	UpdateTag(id string, partialTag models.UpdateTagRequestBody) error
+	UpdateTag(id string, tagBody models.UpdateTagRequestBody) error
 	DeleteTag(id string) error
 }
 
 type TagService struct {
 	DB *gorm.DB
 }
 
-func (t *TagService) CreateTag(partialTag models.CreateTagRequestBody) (*models.Tag, error) {
+func (t *TagService) CreateTag(tagBody models.CreateTagRequestBody) (*models.Tag, error) {
 	tag := models.Tag{
-		Name:       partialTag.Name,
-		CategoryID: partialTag.CategoryID,
+		Name:       tagBody.Name,
+		CategoryID: tagBody.CategoryID,
 	}
 
 	if err := utilities.ValidateData(tag); err != nil {
@@ -42,16 +42,16 @@ func (t *TagService) GetTag(id string) (*models.Tag, error) {
 	return transactions.GetTag(t.DB, *idAsUint)
 }
 
-func (t *TagService) UpdateTag(id string, partialTag models.UpdateTagRequestBody) error {
+func (t *TagService) UpdateTag(id string, tagBody models.UpdateTagRequestBody) error {
 	idAsUint, err := utilities.ValidateID(id)
 
 	if err != nil {
 		return err
 	}
 
 	tag := models.Tag{
-		Name:       partialTag.Name,
-		CategoryID: partialTag.CategoryID,
+		Name:       tagBody.Name,
+		CategoryID: tagBody.CategoryID,
 	}
 
 	if err := utilities.ValidateData(tag); err != nil {

diff --git a/backend/src/utilities/validator.go b/backend/src/utilities/validator.go
@@ -17,6 +17,7 @@ func ValidateData(model interface{}) error {
 	return nil
 }
 
+// Validates that an id follows postgres uint format, returns a uint otherwise returns an error
 func ValidateID(id string) (*uint, error) {
 	idAsInt, err := strconv.Atoi(id)