ami/tl-vikunja
1
0
Fork 0
Code Activity

API Docs improvements (#46)

Browse Source
This commit is contained in:
konrad
2019-01-03 22:22:06 +00:00
committed by Gitea
parent 3183d10dbe
commit 607dbd6ae8
100 changed files with 1306 additions and 9201 deletions
Download Patch File Download Diff File Expand all files Collapse all files

176
pkg/routes/api/v1/docs.go Normal file
View File

File diff suppressed because one or more lines are too long

2
pkg/routes/api/v1/list_by_namespace.go
View File

@ -31,7 +31,7 @@ import (
// @Accept json
// @Produce json
// @Param id path int true "Namespace ID"
// @Security ApiKeyAuth
// @Security JWTKeyAuth
// @Success 200 {array} models.List "The lists."
// @Failure 403 {object} models.Message "No access to that namespace."
// @Failure 404 {object} models.Message "The namespace does not exist."

2
pkg/routes/api/v1/user_list.go
View File

@ -30,7 +30,7 @@ import (
// @Accept json
// @Produce json
// @Param s query string false "Search for a user by its name."
// @Security ApiKeyAuth
// @Security JWTKeyAuth
// @Success 200 {array} models.User "All (found) users."
// @Failure 400 {object} code.vikunja.io/web.HTTPError "Something's invalid."
// @Failure 500 {object} models.Message "Internal server error."

2
pkg/routes/api/v1/user_show.go
View File

@ -29,7 +29,7 @@ import (
// @tags user
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Security JWTKeyAuth
// @Success 200 {object} models.User
// @Failure 404 {object} code.vikunja.io/web.HTTPError "User does not exist."
// @Failure 500 {object} models.Message "Internal server error."

2
pkg/routes/api/v1/user_update_password.go
View File

@ -36,7 +36,7 @@ type UserPassword struct {
// @Accept json
// @Produce json
// @Param userPassword body v1.UserPassword true "The current and new password."
// @Security ApiKeyAuth
// @Security JWTKeyAuth
// @Success 200 {object} models.Message
// @Failure 400 {object} code.vikunja.io/web.HTTPError "Something's invalid."
// @Failure 404 {object} code.vikunja.io/web.HTTPError "User does not exist."