feat: implement Paper Update API (#71)

cmd/app/main.go

@@ -79,6 +79,7 @@ func main() {
 
 	paperApi := api.NewPaperApi(paperUseCase)
 	router.POST("/api/papers/find", paperApi.HandleFind)
+	router.POST("/api/papers/update", paperApi.HandleUpdate)
 
 	err = router.Run(":8080")
 	if err != nil {

docs/openapi/paths/_index.yaml

@@ -14,3 +14,5 @@
   $ref: ./chapters/update.yaml
 /api/papers/find:
   $ref: ./papers/find.yaml
+/api/papers/update:
+  $ref: ./papers/update.yaml

docs/openapi/paths/papers/update.yaml

@@ -0,0 +1,35 @@
+post:
+  tags:
+    - Papers
+  operationId: papers-update
+  summary: Update paper
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: ../../schemas/interface/papers/update/PaperUpdateRequest.yaml
+  responses:
+    "200":
+      description: OK - Returns updated paper
+      content:
+        application/json:
+          schema:
+            $ref: ../../schemas/interface/papers/update/PaperUpdateResponse.yaml
+    "400":
+      description: Bad Request - Invalid request
+      content:
+        application/json:
+          schema:
+            $ref: ../../schemas/interface/papers/update/PaperUpdateErrorResponse.yaml
+    "404":
+      description: Not Found - Paper not found or not authorized
+      content:
+        application/json:
+          schema:
+            $ref: ../../schemas/interface/papers/update/PaperUpdateErrorResponse.yaml
+    "500":
+      description: Internal Server Error - Server error
+      content:
+        application/json:
+          schema:
+            $ref: ../../schemas/interface/app/ApplicationErrorResponse.yaml

docs/openapi/schemas/entity/paper/PaperError.yaml

@@ -0,0 +1,11 @@
+type: object
+description: Error Message for Paper object
+properties:
+  id:
+    type: string
+    description: Error message for paper id
+    example: paper id is required, but got ''
+  content:
+    type: string
+    description: Error message for paper content
+    example: paper content must be less than or equal to 40000 bytes

docs/openapi/schemas/entity/paper/PaperWithoutAutofield.yaml

@@ -1,5 +1,5 @@
 type: object
-description: Paper object
+description: Paper object without auto-generated fields
 properties:
   content:
     type: string

docs/openapi/schemas/entity/paper/PaperWithoutAutofieldError.yaml

@@ -1,7 +1,7 @@
 type: object
-description: Error Message for Paper object
+description: Error Message for PaperWithoutAutofield object
 properties:
   content:
     type: string
     description: Error message for paper content
-    example: paper content must be less than or equal to 40000 bytes
+    example: paper content must be less than or equal to 40000 bytes, but got 43210 bytes

docs/openapi/schemas/interface/papers/find/PaperFindErrorResponse.yaml

@@ -1,5 +1,5 @@
 type: object
-description: Request Body for Paper Find API
+description: Error Response Body for Paper Find API
 properties:
   message:
     type: string

docs/openapi/schemas/interface/papers/update/PaperUpdateErrorResponse.yaml

@@ -0,0 +1,17 @@
+type: object
+description: Error Response Body for Paper Update API
+properties:
+  message:
+    type: string
+    description: Error message when request body format is invalid
+    example: unexpected EOF
+  user:
+    $ref: ../../../entity/user/UserOnlyIdError.yaml
+  project:
+    $ref: ../../../entity/project/ProjectOnlyIdError.yaml
+  paper:
+    $ref: ../../../entity/paper/PaperError.yaml
+required:
+  - user
+  - project
+  - paper

docs/openapi/schemas/interface/papers/update/PaperUpdateRequest.yaml

@@ -0,0 +1,13 @@
+type: object
+description: Request Body for Paper Update API
+properties:
+  user:
+    $ref: ../../../entity/user/UserOnlyId.yaml
+  project:
+    $ref: ../../../entity/project/ProjectOnlyId.yaml
+  paper:
+    $ref: ../../../entity/paper/Paper.yaml
+required:
+  - user
+  - project
+  - paper

docs/openapi/schemas/interface/papers/update/PaperUpdateResponse.yaml

@@ -0,0 +1,7 @@
+type: object
+description: Response Body for Paper Update API
+properties:
+  paper:
+    $ref: ../../../entity/paper/Paper.yaml
+required:
+  - paper

internal/api/paper.go

@@ -10,6 +10,7 @@ import (
 
 type PaperApi interface {
 	HandleFind(c *gin.Context)
+	HandleUpdate(c *gin.Context)
 }
 
 type paperApi struct {
@@ -58,3 +59,42 @@ func (api paperApi) HandleFind(c *gin.Context) {
 
 	c.JSON(http.StatusOK, res)
 }
+
+func (api paperApi) HandleUpdate(c *gin.Context) {
+	var request model.PaperUpdateRequest
+	if err := c.ShouldBindJSON(&request); err != nil {
+		c.JSON(http.StatusBadRequest, model.PaperUpdateErrorResponse{
+			Message: JsonBindErrorToMessage(err),
+		})
+		return
+	}
+
+	res, ucErr := api.usecase.UpdatePaper(request)
+
+	if ucErr != nil && ucErr.Code() == usecase.DomainValidationError {
+		resErr := UseCaseErrorToResponse(ucErr)
+		c.JSON(http.StatusBadRequest, model.PaperUpdateErrorResponse{
+			Message: UseCaseErrorToMessage(ucErr),
+			User:    resErr.User,
+			Project: resErr.Project,
+			Paper:   resErr.Paper,
+		})
+		return
+	}
+
+	if ucErr != nil && ucErr.Code() == usecase.NotFoundError {
+		c.JSON(http.StatusNotFound, model.PaperUpdateErrorResponse{
+			Message: UseCaseErrorToMessage(ucErr),
+		})
+		return
+	}
+
+	if ucErr != nil {
+		c.JSON(http.StatusInternalServerError, model.ApplicationErrorResponse{
+			Message: UseCaseErrorToMessage(ucErr),
+		})
+		return
+	}
+
+	c.JSON(http.StatusOK, res)
+}