chore: add delete review api docs

OpenTreeHole · Apr 8, 2024 · ad2382a · ad2382a
1 parent 9e7831e
commit ad2382a
Show file tree

Hide file tree

Showing 3 changed files with 120 additions and 0 deletions.
diff --git a/danke/docs/docs.go b/danke/docs/docs.go
@@ -458,6 +458,51 @@ const docTemplate = `{
                     }
                 }
             },
+            "delete": {
+                "description": "delete a review, admin or owner can delete",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Review"
+                ],
+                "summary": "delete a review",
+                "parameters": [
+                    {
+                        "type": "integer",
+                        "description": "review id",
+                        "name": "review_id",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "204": {
+                        "description": "No Content"
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "schema": {
+                            "$ref": "#/definitions/common.HttpError"
+                        }
+                    },
+                    "403": {
+                        "description": "Forbidden",
+                        "schema": {
+                            "$ref": "#/definitions/common.HttpError"
+                        }
+                    },
+                    "404": {
+                        "description": "Not Found",
+                        "schema": {
+                            "$ref": "#/definitions/common.HttpError"
+                        }
+                    }
+                }
+            },
             "patch": {
                 "description": "vote for a review",
                 "consumes": [

diff --git a/danke/docs/swagger.json b/danke/docs/swagger.json
@@ -451,6 +451,51 @@
                     }
                 }
             },
+            "delete": {
+                "description": "delete a review, admin or owner can delete",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Review"
+                ],
+                "summary": "delete a review",
+                "parameters": [
+                    {
+                        "type": "integer",
+                        "description": "review id",
+                        "name": "review_id",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "204": {
+                        "description": "No Content"
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "schema": {
+                            "$ref": "#/definitions/common.HttpError"
+                        }
+                    },
+                    "403": {
+                        "description": "Forbidden",
+                        "schema": {
+                            "$ref": "#/definitions/common.HttpError"
+                        }
+                    },
+                    "404": {
+                        "description": "Not Found",
+                        "schema": {
+                            "$ref": "#/definitions/common.HttpError"
+                        }
+                    }
+                }
+            },
             "patch": {
                 "description": "vote for a review",
                 "consumes": [

diff --git a/danke/docs/swagger.yaml b/danke/docs/swagger.yaml
@@ -667,6 +667,36 @@ paths:
       tags:
       - CourseGroup
   /reviews/{review_id}:
+    delete:
+      consumes:
+      - application/json
+      description: delete a review, admin or owner can delete
+      parameters:
+      - description: review id
+        in: path
+        name: review_id
+        required: true
+        type: integer
+      produces:
+      - application/json
+      responses:
+        "204":
+          description: No Content
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/common.HttpError'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/common.HttpError'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/common.HttpError'
+      summary: delete a review
+      tags:
+      - Review
     patch:
       consumes:
       - application/json