summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorzeripath <art27@cantab.net>2018-09-21 09:56:26 +0100
committerLunny Xiao <xiaolunwen@gmail.com>2018-09-21 16:56:26 +0800
commit36e7cb975536adc774e854f64a70694ba3a1e87f (patch)
treec2f259fc364b9888a262dc156d296cd05d76b12d
parentdab02b80fd27a6f1f3a5089cfd16f312a1f89bb7 (diff)
downloadgitea-36e7cb975536adc774e854f64a70694ba3a1e87f.tar.gz
gitea-36e7cb975536adc774e854f64a70694ba3a1e87f.zip
Update Swagger API to match the return of /users/search (#4847)
Signed-off-by: Andrew Thornton <art27@cantab.net>
-rw-r--r--routers/api/v1/user/user.go11
-rw-r--r--templates/swagger/v1_json.tmpl16
2 files changed, 25 insertions, 2 deletions
diff --git a/routers/api/v1/user/user.go b/routers/api/v1/user/user.go
index 49e5f34136..edd5d1b1cb 100644
--- a/routers/api/v1/user/user.go
+++ b/routers/api/v1/user/user.go
@@ -33,7 +33,16 @@ func Search(ctx *context.APIContext) {
// type: integer
// responses:
// "200":
- // "$ref": "#/responses/UserList"
+ // description: "SearchResults of a successful search"
+ // schema:
+ // type: object
+ // properties:
+ // ok:
+ // type: boolean
+ // data:
+ // type: array
+ // items:
+ // "$ref": "#/definitions/User"
opts := &models.SearchUserOptions{
Keyword: strings.Trim(ctx.Query("q"), " "),
Type: models.UserTypeIndividual,
diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl
index aa44e62c72..18fb34ff45 100644
--- a/templates/swagger/v1_json.tmpl
+++ b/templates/swagger/v1_json.tmpl
@@ -5212,7 +5212,21 @@
],
"responses": {
"200": {
- "$ref": "#/responses/UserList"
+ "description": "SearchResults of a successful search",
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/User"
+ }
+ },
+ "ok": {
+ "type": "boolean"
+ }
+ }
+ }
}
}
}