From c9546d4cdd5f7de8f56b7d4a9806d1aca784cf3f Mon Sep 17 00:00:00 2001 From: David Svantesson Date: Sun, 25 Aug 2019 19:06:36 +0200 Subject: Include description in repository search. (#7942) * Add description in repository search. Signed-off-by: David Svantesson * Refactor SearchRepositoryByName with a general function SearchRepository Signed-off-by: David Svantesson * Allow to specify if description shall be included in API repo search. Signed-off-by: David Svantesson * Add new app.ini setting for whether to search within repo description. Signed-off-by: David Svantesson * Search keyword in description (if setting enabled) on: - Explore page - Organization profile page - User profile page - Admin repo page Do not search keyword in description on: - Any non-keyword search (not relevant) - Incremental search (uses API) Signed-off-by: David Svantesson * Put parameters related to keyword directly after it Signed-off-by: David Svantesson * Add test cases for including (and not including) repository description in search. Signed-off-by: David Svantesson * Rename test function from TestSearchRepositoryByName to TestSearchRepository. Signed-off-by: David Svantesson * Make setting SEARCH_REPO_DESCRIPTION default to true Signed-off-by: David Svantesson --- routers/api/v1/repo/repo.go | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) (limited to 'routers/api') diff --git a/routers/api/v1/repo/repo.go b/routers/api/v1/repo/repo.go index 4afe1661d0..eccff8c387 100644 --- a/routers/api/v1/repo/repo.go +++ b/routers/api/v1/repo/repo.go @@ -55,6 +55,10 @@ func Search(ctx *context.APIContext) { // in: query // description: Limit search to repositories with keyword as topic // type: boolean + // - name: includeDesc + // in: query + // description: include search of keyword within repository description + // type: boolean // - name: uid // in: query // description: search only for repos that the user with the given id owns or contributes to @@ -103,16 +107,17 @@ func Search(ctx *context.APIContext) { // "422": // "$ref": "#/responses/validationError" opts := &models.SearchRepoOptions{ - Keyword: strings.Trim(ctx.Query("q"), " "), - OwnerID: ctx.QueryInt64("uid"), - Page: ctx.QueryInt("page"), - PageSize: convert.ToCorrectPageSize(ctx.QueryInt("limit")), - TopicOnly: ctx.QueryBool("topic"), - Collaborate: util.OptionalBoolNone, - Private: ctx.IsSigned && (ctx.Query("private") == "" || ctx.QueryBool("private")), - UserIsAdmin: ctx.IsUserSiteAdmin(), - UserID: ctx.Data["SignedUserID"].(int64), - StarredByID: ctx.QueryInt64("starredBy"), + Keyword: strings.Trim(ctx.Query("q"), " "), + OwnerID: ctx.QueryInt64("uid"), + Page: ctx.QueryInt("page"), + PageSize: convert.ToCorrectPageSize(ctx.QueryInt("limit")), + TopicOnly: ctx.QueryBool("topic"), + Collaborate: util.OptionalBoolNone, + Private: ctx.IsSigned && (ctx.Query("private") == "" || ctx.QueryBool("private")), + UserIsAdmin: ctx.IsUserSiteAdmin(), + UserID: ctx.Data["SignedUserID"].(int64), + StarredByID: ctx.QueryInt64("starredBy"), + IncludeDescription: ctx.QueryBool("includeDesc"), } if ctx.QueryBool("exclusive") { @@ -157,7 +162,7 @@ func Search(ctx *context.APIContext) { } var err error - repos, count, err := models.SearchRepositoryByName(opts) + repos, count, err := models.SearchRepository(opts) if err != nil { ctx.JSON(500, api.SearchError{ OK: false, -- cgit v1.2.3