Skip to content

feat: add a paginated organization members endpoint #16835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Mar 10, 2025
Merged

feat: add a paginated organization members endpoint #16835

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
cea4d3c
feat: add paginated members route
brettkolodny Mar 6, 2025
e97c9db
feat: add request and response types
brettkolodny Mar 6, 2025
34003dc
feat: create new sql query and generate code
brettkolodny Mar 6, 2025
9edb088
fix: add dbauthz tests
brettkolodny Mar 6, 2025
ef40967
feat: implement endpoint
brettkolodny Mar 6, 2025
6aaddaf
fix: correct endpoint documentation
brettkolodny Mar 6, 2025
a724f48
fix: lint errors
brettkolodny Mar 6, 2025
4925592
fix: generated docs from new endpoint
brettkolodny Mar 6, 2025
902538c
fix: remove unneeded comments
brettkolodny Mar 6, 2025
06ff95c
wip
brettkolodny Mar 7, 2025
560305d
Merge branch 'main' into brett/org-members-pagination-backend
brettkolodny Mar 7, 2025
76a4cbf
fix: incorrectly showing type in panic
brettkolodny Mar 7, 2025
737ac9f
fix: update docs
brettkolodny Mar 7, 2025
8910df3
fix: change dbauthz test back to proper one
brettkolodny Mar 7, 2025
0e579a2
fix: un-nest route
brettkolodny Mar 7, 2025
73e356c
fix: add comment
brettkolodny Mar 10, 2025
24332f4
fix: update test to account for dbmem and check for returned member
brettkolodny Mar 10, 2025
7af0b60
fix: update test to check for accurate count
brettkolodny Mar 10, 2025
cdc0322
fix: make dbmem implementation match expected behaior around 0 limit
brettkolodny Mar 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
feat: add paginated members route
  • Loading branch information
@brettkolodny
brettkolodny committed Mar 6, 2025
commit cea4d3cfdc3d14e6f9959d4cb3ce1380fe35dae0
3 changes: 3 additions & 0 deletions coderd/coderd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1002,6 +1002,9 @@ func New(options *Options) *API {
})
})
})
r.Route("/paginated-members", func(r chi.Router) {
r.Get("/", api.paginatedMembers)
})
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really unfortunate we cannot just use the /members endpoint without it being a breaking change.

Since organizations are new, I think it's worth considering.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was originally going to to augment the existing route to be paginated but @aslilac brought up the issue of backwards compatibility. I can circle back with her, and other stakeholders on this

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we were having this discussion like two weeks ago I think I'd agree with you @Emyrk, but 2.20 is out now and marketing organizations as stable. :\

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
r.Route("/paginated-members", func(r chi.Router) {
r.Get("/", api.paginatedMembers)
})
r.Get("/paginated-members", api.paginatedMembers)

I wouldn't bother with the subrouter here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I saw this was a pattern we were doing in other places so copied that. Will change

r.Route("/members", func(r chi.Router) {
r.Get("/", api.listMembers)
r.Route("/roles", func(r chi.Router) {
Expand Down
13 changes: 13 additions & 0 deletions coderd/members.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,19 @@ func (api *API) listMembers(rw http.ResponseWriter, r *http.Request) {
httpapi.Write(ctx, rw, http.StatusOK, resp)
}

// @Summary Paginated organization members
// @ID paginated-organization-members
// @Security CoderSessionToken
// @Produce json
// @Tags Members
// @Param organization path string true "Organization ID"
// @Success 200 {object} []codersdk.OrganizationMemberWithUserData
// @Router /organizations/{organization}/paginated-members [get]
func (api *API) paginatedMembers(rw http.ResponseWriter, r *http.Request) {
ctx := r.Context()
httpapi.Write(ctx, rw, http.StatusNotImplemented, nil)
}

// @Summary Assign role to organization member
// @ID assign-role-to-organization-member
// @Security CoderSessionToken
Expand Down