genofire/golang-lib
genofire
/
golang-lib
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs(swagger): add tags for groups
continuous-integration/drone the build was successful Details

This commit is contained in:
Geno 2021-06-30 15:47:24 +02:00
parent d38a2a28c3
commit cc0baa3740
5 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
web/api/status/main.go
View File

@ -28,6 +28,7 @@ type Status struct {
// @Summary Show Status of current API // @Summary Show Status of current API
// @Description Show version and status // @Description Show version and status
// @Tags status
// @Produce json // @Produce json
// @Success 200 {object} Status // @Success 200 {object} Status
// @Failure 400 {object} web.HTTPError // @Failure 400 {object} web.HTTPError

1
web/auth/api_login.go
View File

@ -18,6 +18,7 @@ type login struct {
// @Summary Login // @Summary Login
// @Description Login by username and password, you will get a cookie of current session // @Description Login by username and password, you will get a cookie of current session
// @Tags auth
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} User // @Success 200 {object} User

1
web/auth/api_password.go
View File

@ -10,6 +10,7 @@ import (
// @Summary Change Password // @Summary Change Password
// @Description Change Password of current login user // @Description Change Password of current login user
// @Tags auth
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} boolean "if password was saved (e.g. `true`)" // @Success 200 {object} boolean "if password was saved (e.g. `true`)"

1
web/auth/api_password_code.go
View File

@ -19,6 +19,7 @@ type PasswordWithForgetCode struct {
// @Summary Change Password with ForgetCode // @Summary Change Password with ForgetCode
// @Description Change Password of any user by generated forget code // @Description Change Password of any user by generated forget code
// @Tags auth
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} string "username of changed password (e.g. `"admin"`)" // @Success 200 {object} string "username of changed password (e.g. `"admin"`)"

1
web/auth/api_status.go
View File

@ -10,6 +10,7 @@ import (
// @Summary Login status // @Summary Login status
// @Description show user_id and username if logged in // @Description show user_id and username if logged in
// @Tags auth
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} User // @Success 200 {object} User