Merge pull request #141 from fsy2001/main

change: PUT routes suffix
OpenTreeHole · Aug 4, 2024 · a6b3be9 · a6b3be9
2 parents 78277e6 + c70e430
commit a6b3be9
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 11 deletions.
diff --git a/danke/api/review.go b/danke/api/review.go
@@ -151,7 +151,7 @@ func CreateReviewV1(c *fiber.Ctx) (err error) {
 // @Param json body schema.ModifyReviewV1Request true "json"
 // @Param review_id path int true "review id"
 // @Router /reviews/{review_id} [put]
-// @Router /reviews/{review_id}/_modify [patch]
+// @Router /reviews/{review_id}/_webvpn [patch]
 // @Success 200 {object} schema.ReviewV1Response
 // @Failure 400 {object} common.HttpError
 // @Failure 404 {object} common.HttpBaseError
@@ -509,7 +509,7 @@ func ListSensitiveReviews(c *fiber.Ctx) (err error) {
 // @Tags Review
 // @Produce application/json
 // @Router /v3/reviews/{id}/_sensitive [put]
-// @Router /v3/reviews/{id}/_sensitive [patch]
+// @Router /v3/reviews/{id}/_sensitive/_webvpn [patch]
 // @Param id path int true "id"
 // @Param json body schema.ModifySensitiveReviewRequest true "json"
 // @Success 200 {object} schema.SensitiveReviewResponse

diff --git a/danke/api/routes.go b/danke/api/routes.go
@@ -40,7 +40,7 @@ func registerRoutes(r fiber.Router) {
 	r.Get("/courses/:id<int>/reviews", ListReviewsV1)
 	r.Post("/courses/:id<int>/reviews", CreateReviewV1)
 	r.Put("/reviews/:id<int>", ModifyReviewV1)
-	r.Patch("/reviews/:id<int>/_modify", ModifyReviewV1)
+	r.Patch("/reviews/:id<int>/_webvpn", ModifyReviewV1)
 	r.Patch("/reviews/:id<int>", VoteForReviewV1)
 	r.Get("/reviews/me", ListMyReviewsV1)
 	r.Get("/reviews/random", GetRandomReviewV1)
@@ -58,5 +58,5 @@ func registerRoutes(r fiber.Router) {
 
 	r.Get("/v3/reviews/_sensitive", ListSensitiveReviews)
 	r.Put("/v3/reviews/:id<int>/_sensitive", ModifyReviewSensitive)
-	r.Patch("/v3/reviews/:id<int>/_sensitive", ModifyReviewSensitive)
+	r.Patch("/v3/reviews/:id<int>/_sensitive/_webvpn", ModifyReviewSensitive)
 }
diff --git a/danke/docs/docs.go b/danke/docs/docs.go
@@ -634,7 +634,7 @@ const docTemplate = `{
                 }
             }
         },
-        "/reviews/{review_id}/_modify": {
+        "/reviews/{review_id}/_webvpn": {
             "patch": {
                 "description": "modify a review, admin or owner can modify",
                 "consumes": [
@@ -895,7 +895,9 @@ const docTemplate = `{
                         }
                     }
                 }
-            },
+            }
+        },
+        "/v3/reviews/{id}/_sensitive/_webvpn": {
             "patch": {
                 "produces": [
                     "application/json"

diff --git a/danke/docs/swagger.json b/danke/docs/swagger.json
@@ -627,7 +627,7 @@
                 }
             }
         },
-        "/reviews/{review_id}/_modify": {
+        "/reviews/{review_id}/_webvpn": {
             "patch": {
                 "description": "modify a review, admin or owner can modify",
                 "consumes": [
@@ -888,7 +888,9 @@
                         }
                     }
                 }
-            },
+            }
+        },
+        "/v3/reviews/{id}/_sensitive/_webvpn": {
             "patch": {
                 "produces": [
                     "application/json"

diff --git a/danke/docs/swagger.yaml b/danke/docs/swagger.yaml
@@ -840,7 +840,7 @@ paths:
       summary: modify a review
       tags:
       - Review
-  /reviews/{review_id}/_modify:
+  /reviews/{review_id}/_webvpn:
     patch:
       consumes:
       - application/json
@@ -1035,7 +1035,7 @@ paths:
       tags:
       - Review
   /v3/reviews/{id}/_sensitive:
-    patch:
+    put:
       parameters:
       - description: id
         in: path
@@ -1062,7 +1062,8 @@ paths:
       summary: Modify A Review's actual_sensitive, admin only
       tags:
       - Review
-    put:
+  /v3/reviews/{id}/_sensitive/_webvpn:
+    patch:
       parameters:
       - description: id
         in: path