summaryrefslogtreecommitdiffstats
path: root/routers/api/v1/swagger/options.go
diff options
context:
space:
mode:
authorstevegt <stevegt@t7a.org>2018-05-31 04:13:55 -0700
committerLunny Xiao <xiaolunwen@gmail.com>2018-05-31 19:13:55 +0800
commit7707ad7a0a6cda66036bd0eec2dead95d8664326 (patch)
tree3903e1e72686a26b559551d13fbb6fdcdcb3a5f3 /routers/api/v1/swagger/options.go
parent728cc272842036ed82ddb88d607e9d5e8bf962a8 (diff)
downloadgitea-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/options.go')
-rw-r--r--routers/api/v1/swagger/options.go1
1 files changed, 1 insertions, 0 deletions
diff --git a/routers/api/v1/swagger/options.go b/routers/api/v1/swagger/options.go
index 3ea324186d..8d9363fe91 100644
--- a/routers/api/v1/swagger/options.go
+++ b/routers/api/v1/swagger/options.go
@@ -12,6 +12,7 @@ import (
// not actually a response, just a hack to get go-swagger to include definitions
// of the various XYZOption structs
+// parameterBodies
// swagger:response parameterBodies
type swaggerParameterBodies struct {
AddCollaboratorOption api.AddCollaboratorOption