From b8f7921b0ba34c32e4f2eba49aa44d605a4641ad Mon Sep 17 00:00:00 2001 From: LucRoy Date: Wed, 10 May 2023 17:59:37 +0000 Subject: [PATCH] docs: update swagger docs --- docs/docs.go | 32 ++++++++++++++++++++++++++++++++ docs/swagger.json | 32 ++++++++++++++++++++++++++++++++ docs/swagger.yaml | 21 +++++++++++++++++++++ 3 files changed, 85 insertions(+) diff --git a/docs/docs.go b/docs/docs.go index a3273f6d..7e1d79e7 100644 --- 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 index 697ae5c3..18a2a725 100644 --- 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 index 2f73f7e6..f995d4c6 100644 --- 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.