Update Swagger API to match the return of /users/search (go-gitea#4847)

Signed-off-by: Andrew Thornton <art27@cantab.net>
tenacubus · Sep 21, 2018 · 36e7cb9 · 36e7cb9
1 parent dab02b8
commit 36e7cb9
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 2 deletions.
diff --git 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
@@ -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"
+                }
+              }
+            }
           }
         }
       }