Merge pull request #9 from vvbbnn00/dev

docs: Update API documentation again
vvbbnn00 · Mar 12, 2024 · 64d3b15 · 64d3b15
2 parents 03a135d + 9ee47c1
commit 64d3b15
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 6 deletions.
diff --git a/docs/docs.go b/docs/docs.go
@@ -116,8 +116,8 @@ const docTemplate = `{
                     }
                 ],
                 "responses": {
-                    "200": {
-                        "description": "OK",
+                    "201": {
+                        "description": "File created",
                         "schema": {
                             "type": "string"
                         }
@@ -744,6 +744,12 @@ const docTemplate = `{
                             "type": "string"
                         }
                     },
+                    "413": {
+                        "description": "File too large",
+                        "schema": {
+                            "type": "string"
+                        }
+                    },
                     "500": {
                         "description": "Internal server error",
                         "schema": {
@@ -806,6 +812,11 @@ const docTemplate = `{
                 }
             },
             "delete": {
+                "security": [
+                    {
+                        "Authorization": []
+                    }
+                ],
                 "description": "Cancel an upload session, {path} should be the relative path of the file, starting from the root directory, e.g. /upload/path/to/file.txt",
                 "tags": [
                     "Upload"

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -109,8 +109,8 @@
                     }
                 ],
                 "responses": {
-                    "200": {
-                        "description": "OK",
+                    "201": {
+                        "description": "File created",
                         "schema": {
                             "type": "string"
                         }
@@ -737,6 +737,12 @@
                             "type": "string"
                         }
                     },
+                    "413": {
+                        "description": "File too large",
+                        "schema": {
+                            "type": "string"
+                        }
+                    },
                     "500": {
                         "description": "Internal server error",
                         "schema": {
@@ -799,6 +805,11 @@
                 }
             },
             "delete": {
+                "security": [
+                    {
+                        "Authorization": []
+                    }
+                ],
                 "description": "Cancel an upload session, {path} should be the relative path of the file, starting from the root directory, e.g. /upload/path/to/file.txt",
                 "tags": [
                     "Upload"

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -159,8 +159,8 @@ paths:
       produces:
       - application/json
       responses:
-        "200":
-          description: OK
+        "201":
+          description: File created
           schema:
             type: string
         "400":
@@ -582,6 +582,8 @@ paths:
           description: Internal server error
           schema:
             type: string
+      security:
+      - Authorization: []
       summary: Cancel Upload
       tags:
       - Upload
@@ -647,6 +649,10 @@ paths:
           description: Directory creation not allowed
           schema:
             type: string
+        "413":
+          description: File too large
+          schema:
+            type: string
         "500":
           description: Internal server error
           schema: