API endpoint for searching teams. #8108

davidsvantesson · 2019-09-05T20:44:52Z

Add API endpoint GET /orgs/{org}/teams/search for searching teams.
This is needed for #8045, but as it is working code by itself I thought it is better to make a smaller PR first.

Signed-off-by: dasv <[email protected]>

codecov-io · 2019-09-05T22:08:39Z

Codecov Report

❗ No coverage uploaded for pull request base (master@d3bc3dd). Click here to learn what that means.
The diff coverage is 79.16%.

@@            Coverage Diff            @@
##             master    #8108   +/-   ##
=========================================
  Coverage          ?   41.64%           
=========================================
  Files             ?      495           
  Lines             ?    65523           
  Branches          ?        0           
=========================================
  Hits              ?    27285           
  Misses            ?    34721           
  Partials          ?     3517

Impacted Files	Coverage Δ
routers/api/v1/api.go	`73% <100%> (ø)`
routers/api/v1/org/team.go	`38.18% <78.08%> (ø)`
models/org_team.go	`54.71% <78.57%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d3bc3dd...5785acd. Read the comment docs.

lafriks · 2019-09-06T06:05:50Z

Why is global team search needed? Imho it should be under /orgs/<orgname>/teams/search route

davidsvantesson · 2019-09-06T07:14:53Z

Maybe possibility to search all teams you belong to or admin want to search all teams in installation? I considered if it should be under the organization but didn't want to restrict future possibilities too much. Anyhow I only need the search within an organization so it doesn't matter to me.

lafriks · 2019-09-06T13:57:24Z

Currently I do not see use case for this and I would want to reserve /teams route for global user groups/teams when we implement such

Signed-off-by: David Svantesson <[email protected]>

davidsvantesson · 2019-09-06T16:36:21Z

Ok, changed to /orgs/{org}/teams/search.

Signed-off-by: David Svantesson <[email protected]>

routers/api/v1/org/team.go

grammar Co-Authored-By: Richard Mahn <[email protected]>

davidsvantesson · 2019-09-12T18:47:20Z

I have added a few test cases for this as well, so I consider it ready for review.

models/org_team.go

routers/api/v1/org/team.go

Signed-off-by: David Svantesson <[email protected]>

…his PR. Signed-off-by: David Svantesson <[email protected]>

davidsvantesson · 2019-09-23T21:54:35Z

@guillep2k Maybe you could take some time to review this?
Although #8045 can add teams without this, the team search field does not work. I think I messed up a bit by separating these PRs, sorry.

integrations/api_team_test.go

Signed-off-by: David Svantesson <[email protected]>

guillep2k · 2019-09-23T23:15:30Z

models/org_team.go

+// SearchTeamOptions holds the search options
+type SearchTeamOptions struct {
+	UserID      int64
+	UserIsAdmin bool


UserIsAdmin is not used? I guess the router takes care of the permissions, but why is it here?

guillep2k · 2019-09-23T23:16:15Z

models/org_team.go

+	Keyword     string
+	OrgID       int64
+	IncludeDesc bool
+	Limit       int


I didn't check other API endpoints, but isn't it a bit strange to limit the query while not supporting pagination?

Pagination added to the API.

Signed-off-by: David Svantesson <[email protected]>

davidsvantesson · 2019-09-27T06:24:13Z

Can this be merged?

lunny · 2019-09-27T07:20:39Z

models/org_team.go

+
+	if len(opts.Keyword) > 0 {
+		lowerKeyword := strings.ToLower(opts.Keyword)
+		var keywordCond = builder.NewCond()


var keywordCond = builder.Like{"lower_name"} if opts.IncludeDesc { keywordCond = keywordCond.Or(builder.Like{"LOWER(description)", lowerKeyword}) }

:(
var keywordCond builder.Cond = builder.Like{"lower_name"}

Sorry, ran out of laptop battery before I could finish properly. Will fix later.

Now I think I got it right.

models/org_team.go

lunny · 2019-09-27T07:26:40Z

routers/api/v1/org/team.go

+	//             "$ref": "#/definitions/Team"
+	opts := &models.SearchTeamOptions{
+		UserID:      ctx.Data["SignedUserID"].(int64),
+		Keyword:     strings.Trim(ctx.Query("q"), " "),


strings.TrimSpace

lunny · 2019-09-27T07:26:58Z

routers/api/v1/org/team.go

+	//           items:
+	//             "$ref": "#/definitions/Team"
+	opts := &models.SearchTeamOptions{
+		UserID:      ctx.Data["SignedUserID"].(int64),


ctx.User.ID

lunny · 2019-09-27T07:27:29Z

routers/api/v1/org/team.go

+		UserID:      ctx.Data["SignedUserID"].(int64),
+		Keyword:     strings.Trim(ctx.Query("q"), " "),
+		OrgID:       ctx.Org.Organization.ID,
+		IncludeDesc: (ctx.Query("inclDesc") == "" || ctx.QueryBool("inclDesc")),


Maybe include_desc is better.

Signed-off-by: David Svantesson <[email protected]>

Api endpoint for searching teams.

7cfa3d5

Signed-off-by: dasv <[email protected]>

davidsvantesson force-pushed the api-endpoint-teams-search branch from bcddfd5 to 7cfa3d5 Compare September 5, 2019 20:47

Merge branch 'master' into api-endpoint-teams-search

62c798f

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Sep 5, 2019

lunny added the modifies/api This PR adds API routes or modifies them label Sep 6, 2019

Move API to /orgs/:org/teams/search

ebecd5a

Signed-off-by: David Svantesson <[email protected]>

davidsvantesson force-pushed the api-endpoint-teams-search branch from 49baf42 to ebecd5a Compare September 6, 2019 15:17

davidsvantesson added 2 commits September 6, 2019 15:31

Regenerate swagger

2476663

Signed-off-by: David Svantesson <[email protected]>

Fix search is Get

0f075c1

Signed-off-by: David Svantesson <[email protected]>

Add test for search team API.

bfbc4ab

Signed-off-by: David Svantesson <[email protected]>

richmahn suggested changes Sep 6, 2019

View reviewed changes

routers/api/v1/org/team.go Outdated Show resolved Hide resolved

Update routers/api/v1/org/team.go

ff4520b

grammar Co-Authored-By: Richard Mahn <[email protected]>

davidsvantesson force-pushed the api-endpoint-teams-search branch from 3d52c44 to ff4520b Compare September 6, 2019 20:29

lafriks requested changes Sep 12, 2019

View reviewed changes

davidsvantesson added 2 commits September 13, 2019 06:14

Fix review comments

a1e1a9a

Signed-off-by: David Svantesson <[email protected]>

Merge branch 'master' into api-endpoint-teams-search

76a5901

lafriks approved these changes Sep 13, 2019

View reviewed changes

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Sep 13, 2019

davidsvantesson mentioned this pull request Sep 17, 2019

Add teams to repo on collaboration page. #8045

Merged

davidsvantesson added 2 commits September 23, 2019 23:40

Merge branch 'master' into api-endpoint-teams-search

30e014c

Fix some issues in repo collaboration team search, after changes in t…

57bf392

…his PR. Signed-off-by: David Svantesson <[email protected]>

guillep2k suggested changes Sep 23, 2019

View reviewed changes

integrations/api_team_test.go Outdated Show resolved Hide resolved

Remove teamUser which is not used and replace with actual user id.

0745ee4

Signed-off-by: David Svantesson <[email protected]>

guillep2k reviewed Sep 23, 2019

View reviewed changes

davidsvantesson added 4 commits September 24, 2019 08:28

Remove unused search variable UserIsAdmin.

e74347a

Add paging to team search.

f1de2b1

Re-genereate swagger

a632034

Signed-off-by: David Svantesson <[email protected]>

Merge branch 'master' into api-endpoint-teams-search

03861f1

guillep2k approved these changes Sep 24, 2019

View reviewed changes

GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Sep 24, 2019

lunny reviewed Sep 27, 2019

View reviewed changes

models/org_team.go Show resolved Hide resolved

lunny requested changes Sep 27, 2019

View reviewed changes

davidsvantesson added 3 commits September 28, 2019 07:34

Fix review comments

9704d49

Signed-off-by: David Svantesson <[email protected]>

fix

b101793

Regenerate swagger

4288527

lunny approved these changes Sep 30, 2019

View reviewed changes

lunny added 4 commits September 30, 2019 09:47

Merge branch 'master' into api-endpoint-teams-search

8755739

Merge branch 'master' into api-endpoint-teams-search

fc66f6a

Merge branch 'master' into api-endpoint-teams-search

b31fc41

Merge branch 'master' into api-endpoint-teams-search

5785acd

adelowo approved these changes Sep 30, 2019

View reviewed changes

lunny merged commit 36bcd4c into go-gitea:master Oct 1, 2019

davidsvantesson deleted the api-endpoint-teams-search branch October 17, 2019 09:03

go-gitea locked and limited conversation to collaborators Nov 24, 2020

6543 added this to the 1.10.0 milestone May 19, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API endpoint for searching teams. #8108

API endpoint for searching teams. #8108

davidsvantesson commented Sep 5, 2019 •

edited

Loading

codecov-io commented Sep 5, 2019 •

edited

Loading

lafriks commented Sep 6, 2019 •

edited

Loading

davidsvantesson commented Sep 6, 2019

lafriks commented Sep 6, 2019

davidsvantesson commented Sep 6, 2019

davidsvantesson commented Sep 12, 2019

davidsvantesson commented Sep 23, 2019

guillep2k Sep 23, 2019

davidsvantesson Sep 24, 2019

guillep2k Sep 23, 2019

davidsvantesson Sep 24, 2019

davidsvantesson commented Sep 27, 2019

lunny Sep 27, 2019 •

edited

Loading

lunny Sep 28, 2019

davidsvantesson Sep 28, 2019

davidsvantesson Sep 29, 2019

lunny Sep 27, 2019

lunny Sep 27, 2019

lunny Sep 27, 2019

API endpoint for searching teams. #8108

API endpoint for searching teams. #8108

Conversation

davidsvantesson commented Sep 5, 2019 • edited Loading

codecov-io commented Sep 5, 2019 • edited Loading

Codecov Report

lafriks commented Sep 6, 2019 • edited Loading

davidsvantesson commented Sep 6, 2019

lafriks commented Sep 6, 2019

davidsvantesson commented Sep 6, 2019

davidsvantesson commented Sep 12, 2019

davidsvantesson commented Sep 23, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidsvantesson commented Sep 27, 2019

lunny Sep 27, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidsvantesson commented Sep 5, 2019 •

edited

Loading

codecov-io commented Sep 5, 2019 •

edited

Loading

lafriks commented Sep 6, 2019 •

edited

Loading

lunny Sep 27, 2019 •

edited

Loading