diff options
| author | stevegt <stevegt@t7a.org> | 2018-05-31 04:13:55 -0700 |
|---|---|---|
| committer | Lunny Xiao <xiaolunwen@gmail.com> | 2018-05-31 19:13:55 +0800 |
| commit | 7707ad7a0a6cda66036bd0eec2dead95d8664326 (patch) | |
| tree | 3903e1e72686a26b559551d13fbb6fdcdcb3a5f3 /routers/api/v1/swagger/user.go | |
| parent | 728cc272842036ed82ddb88d607e9d5e8bf962a8 (diff) | |
| download | gitea-7707ad7a0a6cda66036bd0eec2dead95d8664326.tar.gz gitea-7707ad7a0a6cda66036bd0eec2dead95d8664326.zip | |
add simple descriptions for swagger validate (#4087)
* Partial fix for #4010
Swagger needs a comment line above each swagger:response comment -- it
uses these to populate the description: fields. Adding minimal text
for now on the way to getting swagger validate to pass. Many standard
swagger client libraries will not work at all with gitea until validate
passes, so prioritizing that over better descriptions for now.
Signed-off-by: Steve Traugott <stevegt@t7a.org>
Diffstat (limited to 'routers/api/v1/swagger/user.go')
| -rw-r--r-- | routers/api/v1/swagger/user.go | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/routers/api/v1/swagger/user.go b/routers/api/v1/swagger/user.go index 2bb8f1b76b..7ae046a9b0 100644 --- a/routers/api/v1/swagger/user.go +++ b/routers/api/v1/swagger/user.go @@ -8,18 +8,21 @@ import ( api "code.gitea.io/sdk/gitea" ) +// User // swagger:response User type swaggerResponseUser struct { // in:body Body api.User `json:"body"` } +// UserList // swagger:response UserList type swaggerResponseUserList struct { // in:body Body []api.User `json:"body"` } +// EmailList // swagger:response EmailList type swaggerResponseEmailList struct { // in:body |