From cc0baa3740c1e2194b126cd855c5f771fcbf2341 Mon Sep 17 00:00:00 2001 From: Geno Date: Wed, 30 Jun 2021 15:47:24 +0200 Subject: [PATCH] docs(swagger): add tags for groups --- web/api/status/main.go | 1 + web/auth/api_login.go | 1 + web/auth/api_password.go | 1 + web/auth/api_password_code.go | 1 + web/auth/api_status.go | 1 + 5 files changed, 5 insertions(+) diff --git a/web/api/status/main.go b/web/api/status/main.go index e333fe9..b28670a 100644 --- a/web/api/status/main.go +++ b/web/api/status/main.go @@ -28,6 +28,7 @@ type Status struct { // @Summary Show Status of current API // @Description Show version and status +// @Tags status // @Produce json // @Success 200 {object} Status // @Failure 400 {object} web.HTTPError diff --git a/web/auth/api_login.go b/web/auth/api_login.go index f90060a..85ab3ff 100644 --- a/web/auth/api_login.go +++ b/web/auth/api_login.go @@ -18,6 +18,7 @@ type login struct { // @Summary Login // @Description Login by username and password, you will get a cookie of current session +// @Tags auth // @Accept json // @Produce json // @Success 200 {object} User diff --git a/web/auth/api_password.go b/web/auth/api_password.go index e849450..b548857 100644 --- a/web/auth/api_password.go +++ b/web/auth/api_password.go @@ -10,6 +10,7 @@ import ( // @Summary Change Password // @Description Change Password of current login user +// @Tags auth // @Accept json // @Produce json // @Success 200 {object} boolean "if password was saved (e.g. `true`)" diff --git a/web/auth/api_password_code.go b/web/auth/api_password_code.go index 330fa27..e3d6ca1 100644 --- a/web/auth/api_password_code.go +++ b/web/auth/api_password_code.go @@ -19,6 +19,7 @@ type PasswordWithForgetCode struct { // @Summary Change Password with ForgetCode // @Description Change Password of any user by generated forget code +// @Tags auth // @Accept json // @Produce json // @Success 200 {object} string "username of changed password (e.g. `"admin"`)" diff --git a/web/auth/api_status.go b/web/auth/api_status.go index 6706b91..c4b03d4 100644 --- a/web/auth/api_status.go +++ b/web/auth/api_status.go @@ -10,6 +10,7 @@ import ( // @Summary Login status // @Description show user_id and username if logged in +// @Tags auth // @Accept json // @Produce json // @Success 200 {object} User