Comments added

Author: shashvat-kedia

models/user.go

@@ -1360,6 +1360,8 @@ func SearchUsers(opts *SearchUserOptions) (users []*User, _ int64, _ error) {
 		Find(&users)
 }
 
+//SearchUsersAPI takes options i.e keyword and part of user name to search
+//it returns all the results found and the number of total results.
 func SearchUsersAPI(opts *SearchUserOptions) (users []*User,_ int64,_ error){
 	cond := opts.toConds()
 	count,err := x.Where(cond).Count(new(User))

routers/api/v1/admin/org.go

@@ -67,7 +67,18 @@ func CreateOrg(ctx *context.APIContext, form api.CreateOrgOption) {
 	ctx.JSON(201, convert.ToOrganization(org))
 }
 
+//GetAllOrgs API for getting information of all the organizations
 func GetAllOrgs(ctx *context.APIContext){
+	// swagger:operation GET /admin/orgs admin adminGetAllOrgs
+	// ---
+	// summary: List all organizations
+	// produces:
+	// - application/json
+	// responses:
+	//   "200":
+	//     "$ref": "#/responses/OrganizationList"
+	//   "403":
+	//     "$ref": "#/responses/forbidden"
 	users,_,err := models.SearchUsersAPI(&models.SearchUserOptions{
 		Type:  models.UserTypeOrganization,
 		OrderBy: models.SearchOrderByAlphabetically,

routers/api/v1/admin/user.go

@@ -292,7 +292,18 @@ func DeleteUserPublicKey(ctx *context.APIContext) {
 	ctx.Status(204)
 }
 
+//GetAllUsers API for getting information of all the users
 func GetAllUsers(ctx *context.APIContext){
+	// swagger:operation GET /admin/users admin adminGetAllUsers
+	// ---
+	// summary: List all organizations
+	// produces:
+	// - application/json
+	// responses:
+	//   "200":
+	//     "$ref": "#/responses/UserList"
+	//   "403":
+	//     "$ref": "#/responses/forbidden"
 	users,_,err := models.SearchUsersAPI(&models.SearchUserOptions{
 		Type: models.UserTypeIndividual,
 		OrderBy: models.SearchOrderByAlphabetically,