aboutsummaryrefslogtreecommitdiffstats
path: root/routers/api/v1/org
diff options
context:
space:
mode:
authorSpaWn2KiLl <SpaWn2KiLl@users.noreply.github.com>2020-01-24 19:00:29 +0000
committertechknowlogick <techknowlogick@gitea.io>2020-01-24 14:00:29 -0500
commit1f01f53c53ea75634f981611635be49c69e1920b (patch)
treedd99285ba1d9a8a888f8deccef7865e53901d859 /routers/api/v1/org
parent333401e0fdca1abe096257479e7090c6e69985ec (diff)
downloadgitea-1f01f53c53ea75634f981611635be49c69e1920b.tar.gz
gitea-1f01f53c53ea75634f981611635be49c69e1920b.zip
API add/generalize pagination (#9452)
* paginate results * fixed deadlock * prevented breaking change * updated swagger * go fmt * fixed find topic * go mod tidy * go mod vendor with go1.13.5 * fixed repo find topics * fixed unit test * added Limit method to Engine struct; use engine variable when provided; fixed gitignore * use ItemsPerPage for default pagesize; fix GetWatchers, getOrgUsersByOrgID and GetStargazers; fix GetAllCommits headers; reverted some changed behaviors * set Page value on Home route * improved memory allocations * fixed response headers * removed logfiles * fixed import order * import order * improved swagger * added function to get models.ListOptions from context * removed pagesize diff on unit test * fixed imports * removed unnecessary struct field * fixed go fmt * scoped PR * code improvements * code improvements * go mod tidy * fixed import order * fixed commit statuses session * fixed files headers * fixed headers; added pagination for notifications * go mod tidy * go fmt * removed Private from user search options; added setting.UI.IssuePagingNum as default valeu on repo's issues list * Apply suggestions from code review Co-Authored-By: 6543 <6543@obermui.de> Co-Authored-By: zeripath <art27@cantab.net> * fixed build error * CI.restart() * fixed merge conflicts resolve * fixed conflicts resolve * improved FindTrackedTimesOptions.ToOptions() method * added backwards compatibility on ListReleases request; fixed issue tracked time ToSession * fixed build error; fixed swagger template * fixed swagger template * fixed ListReleases backwards compatibility * added page to user search route Co-authored-by: techknowlogick <matti@mdranta.net> Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: zeripath <art27@cantab.net>
Diffstat (limited to 'routers/api/v1/org')
-rw-r--r--routers/api/v1/org/hook.go10
-rw-r--r--routers/api/v1/org/member.go24
-rw-r--r--routers/api/v1/org/org.go32
-rw-r--r--routers/api/v1/org/team.go59
4 files changed, 105 insertions, 20 deletions
diff --git a/routers/api/v1/org/hook.go b/routers/api/v1/org/hook.go
index b3faac7b51..2fd084a13a 100644
--- a/routers/api/v1/org/hook.go
+++ b/routers/api/v1/org/hook.go
@@ -27,12 +27,20 @@ func ListHooks(ctx *context.APIContext) {
// description: name of the organization
// type: string
// required: true
+ // - name: page
+ // in: query
+ // description: page number of results to return (1-based)
+ // type: integer
+ // - name: limit
+ // in: query
+ // description: page size of results, maximum page size is 50
+ // type: integer
// responses:
// "200":
// "$ref": "#/responses/HookList"
org := ctx.Org.Organization
- orgHooks, err := models.GetWebhooksByOrgID(org.ID)
+ orgHooks, err := models.GetWebhooksByOrgID(org.ID, utils.GetListOptions(ctx))
if err != nil {
ctx.Error(http.StatusInternalServerError, "GetWebhooksByOrgID", err)
return
diff --git a/routers/api/v1/org/member.go b/routers/api/v1/org/member.go
index 1575600a65..6450577f4c 100644
--- a/routers/api/v1/org/member.go
+++ b/routers/api/v1/org/member.go
@@ -14,14 +14,16 @@ import (
"code.gitea.io/gitea/modules/setting"
api "code.gitea.io/gitea/modules/structs"
"code.gitea.io/gitea/routers/api/v1/user"
+ "code.gitea.io/gitea/routers/api/v1/utils"
)
// listMembers list an organization's members
func listMembers(ctx *context.APIContext, publicOnly bool) {
var members []*models.User
- members, _, err := models.FindOrgMembers(models.FindOrgMembersOpts{
- OrgID: ctx.Org.Organization.ID,
- PublicOnly: publicOnly,
+ members, _, err := models.FindOrgMembers(&models.FindOrgMembersOpts{
+ OrgID: ctx.Org.Organization.ID,
+ PublicOnly: publicOnly,
+ ListOptions: utils.GetListOptions(ctx),
})
if err != nil {
ctx.Error(http.StatusInternalServerError, "GetUsersByIDs", err)
@@ -48,6 +50,14 @@ func ListMembers(ctx *context.APIContext) {
// description: name of the organization
// type: string
// required: true
+ // - name: page
+ // in: query
+ // description: page number of results to return (1-based)
+ // type: integer
+ // - name: limit
+ // in: query
+ // description: page size of results, maximum page size is 50
+ // type: integer
// responses:
// "200":
// "$ref": "#/responses/UserList"
@@ -75,6 +85,14 @@ func ListPublicMembers(ctx *context.APIContext) {
// description: name of the organization
// type: string
// required: true
+ // - name: page
+ // in: query
+ // description: page number of results to return (1-based)
+ // type: integer
+ // - name: limit
+ // in: query
+ // description: page size of results, maximum page size is 50
+ // type: integer
// produces:
// - application/json
// responses:
diff --git a/routers/api/v1/org/org.go b/routers/api/v1/org/org.go
index 4bcd60a679..fde58bd5c1 100644
--- a/routers/api/v1/org/org.go
+++ b/routers/api/v1/org/org.go
@@ -13,10 +13,14 @@ import (
"code.gitea.io/gitea/modules/convert"
api "code.gitea.io/gitea/modules/structs"
"code.gitea.io/gitea/routers/api/v1/user"
+ "code.gitea.io/gitea/routers/api/v1/utils"
)
func listUserOrgs(ctx *context.APIContext, u *models.User, all bool) {
- if err := u.GetOrganizations(all); err != nil {
+ if err := u.GetOrganizations(&models.SearchOrganizationsOptions{
+ ListOptions: utils.GetListOptions(ctx),
+ All: all,
+ }); err != nil {
ctx.Error(http.StatusInternalServerError, "GetOrganizations", err)
return
}
@@ -35,6 +39,15 @@ func ListMyOrgs(ctx *context.APIContext) {
// summary: List the current user's organizations
// produces:
// - application/json
+ // parameters:
+ // - name: page
+ // in: query
+ // description: page number of results to return (1-based)
+ // type: integer
+ // - name: limit
+ // in: query
+ // description: page size of results, maximum page size is 50
+ // type: integer
// responses:
// "200":
// "$ref": "#/responses/OrganizationList"
@@ -55,6 +68,14 @@ func ListUserOrgs(ctx *context.APIContext) {
// description: username of user
// type: string
// required: true
+ // - name: page
+ // in: query
+ // description: page number of results to return (1-based)
+ // type: integer
+ // - name: limit
+ // in: query
+ // description: page size of results, maximum page size is 50
+ // type: integer
// responses:
// "200":
// "$ref": "#/responses/OrganizationList"
@@ -95,11 +116,10 @@ func GetAll(ctx *context.APIContext) {
}
publicOrgs, _, err := models.SearchUsers(&models.SearchUserOptions{
- Type: models.UserTypeOrganization,
- OrderBy: models.SearchOrderByAlphabetically,
- Page: ctx.QueryInt("page"),
- PageSize: convert.ToCorrectPageSize(ctx.QueryInt("limit")),
- Visible: vMode,
+ ListOptions: utils.GetListOptions(ctx),
+ Type: models.UserTypeOrganization,
+ OrderBy: models.SearchOrderByAlphabetically,
+ Visible: vMode,
})
if err != nil {
ctx.Error(http.StatusInternalServerError, "SearchOrganizations", err)
diff --git a/routers/api/v1/org/team.go b/routers/api/v1/org/team.go
index 446287a343..1bf984b17f 100644
--- a/routers/api/v1/org/team.go
+++ b/routers/api/v1/org/team.go
@@ -15,6 +15,7 @@ import (
"code.gitea.io/gitea/modules/log"
api "code.gitea.io/gitea/modules/structs"
"code.gitea.io/gitea/routers/api/v1/user"
+ "code.gitea.io/gitea/routers/api/v1/utils"
)
// ListTeams list all the teams of an organization
@@ -30,12 +31,22 @@ func ListTeams(ctx *context.APIContext) {
// description: name of the organization
// type: string
// required: true
+ // - name: page
+ // in: query
+ // description: page number of results to return (1-based)
+ // type: integer
+ // - name: limit
+ // in: query
+ // description: page size of results, maximum page size is 50
+ // type: integer
// responses:
// "200":
// "$ref": "#/responses/TeamList"
org := ctx.Org.Organization
- if err := org.GetTeams(); err != nil {
+ if err := org.GetTeams(&models.SearchTeamOptions{
+ ListOptions: utils.GetListOptions(ctx),
+ }); err != nil {
ctx.Error(http.StatusInternalServerError, "GetTeams", err)
return
}
@@ -59,11 +70,20 @@ func ListUserTeams(ctx *context.APIContext) {
// summary: List all the teams a user belongs to
// produces:
// - application/json
+ // parameters:
+ // - name: page
+ // in: query
+ // description: page number of results to return (1-based)
+ // type: integer
+ // - name: limit
+ // in: query
+ // description: page size of results, maximum page size is 50
+ // type: integer
// responses:
// "200":
// "$ref": "#/responses/TeamList"
- teams, err := models.GetUserTeams(ctx.User.ID)
+ teams, err := models.GetUserTeams(ctx.User.ID, utils.GetListOptions(ctx))
if err != nil {
ctx.Error(http.StatusInternalServerError, "GetUserTeams", err)
return
@@ -284,6 +304,14 @@ func GetTeamMembers(ctx *context.APIContext) {
// type: integer
// format: int64
// required: true
+ // - name: page
+ // in: query
+ // description: page number of results to return (1-based)
+ // type: integer
+ // - name: limit
+ // in: query
+ // description: page size of results, maximum page size is 50
+ // type: integer
// responses:
// "200":
// "$ref": "#/responses/UserList"
@@ -297,7 +325,9 @@ func GetTeamMembers(ctx *context.APIContext) {
return
}
team := ctx.Org.Team
- if err := team.GetMembers(); err != nil {
+ if err := team.GetMembers(&models.SearchMembersOptions{
+ ListOptions: utils.GetListOptions(ctx),
+ }); err != nil {
ctx.Error(http.StatusInternalServerError, "GetTeamMembers", err)
return
}
@@ -436,12 +466,22 @@ func GetTeamRepos(ctx *context.APIContext) {
// type: integer
// format: int64
// required: true
+ // - name: page
+ // in: query
+ // description: page number of results to return (1-based)
+ // type: integer
+ // - name: limit
+ // in: query
+ // description: page size of results, maximum page size is 50
+ // type: integer
// responses:
// "200":
// "$ref": "#/responses/RepositoryList"
team := ctx.Org.Team
- if err := team.GetRepositories(); err != nil {
+ if err := team.GetRepositories(&models.SearchTeamOptions{
+ ListOptions: utils.GetListOptions(ctx),
+ }); err != nil {
ctx.Error(http.StatusInternalServerError, "GetTeamRepos", err)
}
repos := make([]*api.Repository, len(team.Repos))
@@ -589,14 +629,14 @@ func SearchTeam(ctx *context.APIContext) {
// in: query
// description: include search within team description (defaults to true)
// type: boolean
- // - name: limit
- // in: query
- // description: limit size of results
- // type: integer
// - name: page
// in: query
// description: page number of results to return (1-based)
// type: integer
+ // - name: limit
+ // in: query
+ // description: page size of results, maximum page size is 50
+ // type: integer
// responses:
// "200":
// description: "SearchResults of a successful search"
@@ -615,8 +655,7 @@ func SearchTeam(ctx *context.APIContext) {
Keyword: strings.TrimSpace(ctx.Query("q")),
OrgID: ctx.Org.Organization.ID,
IncludeDesc: (ctx.Query("include_desc") == "" || ctx.QueryBool("include_desc")),
- PageSize: ctx.QueryInt("limit"),
- Page: ctx.QueryInt("page"),
+ ListOptions: utils.GetListOptions(ctx),
}
teams, _, err := models.SearchTeam(opts)