docs: update swagger docs

application-research · May 10, 2023 · b8f7921 · b8f7921
1 parent 42a3d0e
commit b8f7921
Show file tree

Hide file tree

Showing 3 changed files with 85 additions and 0 deletions.
diff --git a/docs/docs.go b/docs/docs.go
@@ -3291,6 +3291,38 @@ const docTemplate = `{
                 }
             }
         },
+        "/user/utilization": {
+            "get": {
+                "description": "This endpoint is used to get utilization stats for the current user.",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "User"
+                ],
+                "summary": "Gets User Utilization Stats",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "string"
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "schema": {
+                            "$ref": "#/definitions/util.HttpError"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/util.HttpError"
+                        }
+                    }
+                }
+            }
+        },
         "/viewer": {
             "get": {
                 "description": "This endpoint fetches viewer details such as username, permissions, address, owned miners, user settings etc.",

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -3284,6 +3284,38 @@
         }
       }
     },
+    "/user/utilization": {
+      "get": {
+        "description": "This endpoint is used to get utilization stats for the current user.",
+        "produces": [
+          "application/json"
+        ],
+        "tags": [
+          "User"
+        ],
+        "summary": "Gets User Utilization Stats",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "type": "string"
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "schema": {
+              "$ref": "#/definitions/util.HttpError"
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "schema": {
+              "$ref": "#/definitions/util.HttpError"
+            }
+          }
+        }
+      }
+    },
     "/viewer": {
       "get": {
         "description": "This endpoint fetches viewer details such as username, permissions, address, owned miners, user settings etc.",

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -2549,6 +2549,27 @@ paths:
       summary: Get stats for the current user
       tags:
         - User
+  /user/utilization:
+    get:
+      description: This endpoint is used to get utilization stats for the current user.
+      produces:
+        - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            type: string
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/util.HttpError'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/util.HttpError'
+      summary: Gets User Utilization Stats
+      tags:
+        - User
   /viewer:
     get:
       description: This endpoint fetches viewer details such as username, permissions, address, owned miners, user settings etc.