Browse Source

Page parameter for repo search API (#2915)

for-closed-social
Ethan Koenig 6 years ago
committed by Lunny Xiao
parent
commit
d22a8dc022
2 changed files with 17 additions and 6 deletions
  1. +9
    -3
      public/swagger.v1.json
  2. +8
    -3
      routers/api/v1/repo/repo.go

+ 9
- 3
public/swagger.v1.json View File

@ -849,13 +849,19 @@
},
{
"type": "integer",
"description": "if provided, will return only repos owned by the user with the given id",
"description": "search only for repos that the user with the given id owns or contributes to",
"name": "uid",
"in": "query"
},
{
"type": "integer",
"description": "maximum number of repos to return",
"description": "page number of results to return (1-based)",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size of results, maximum page size is 50",
"name": "limit",
"in": "query"
},
@ -867,7 +873,7 @@
},
{
"type": "boolean",
"description": "only search for repositories owned by the authenticated user",
"description": "if `uid` is given, search only for repos that the user owns",
"name": "exclusive",
"in": "query"
}

+ 8
- 3
routers/api/v1/repo/repo.go View File

@ -34,11 +34,15 @@ func Search(ctx *context.APIContext) {
// type: string
// - name: uid
// in: query
// description: if provided, will return only repos owned by the user with the given id
// description: search only for repos that the user with the given id owns or contributes to
// type: integer
// - name: page
// in: query
// description: page number of results to return (1-based)
// type: integer
// - name: limit
// in: query
// description: maximum number of repos to return
// description: page size of results, maximum page size is 50
// type: integer
// - name: mode
// in: query
@ -47,7 +51,7 @@ func Search(ctx *context.APIContext) {
// type: string
// - name: exclusive
// in: query
// description: only search for repositories owned by the authenticated user
// description: if `uid` is given, search only for repos that the user owns
// type: boolean
// responses:
// "200":
@ -57,6 +61,7 @@ func Search(ctx *context.APIContext) {
opts := &models.SearchRepoOptions{
Keyword: strings.Trim(ctx.Query("q"), " "),
OwnerID: ctx.QueryInt64("uid"),
Page: ctx.QueryInt("page"),
PageSize: convert.ToCorrectPageSize(ctx.QueryInt("limit")),
Collaborate: util.OptionalBoolNone,
}

Loading…
Cancel
Save