Skip to content

Commit 737ac9f

Browse files
committed
fix: update docs
1 parent 76a4cbf commit 737ac9f

File tree

5 files changed

+26
-9
lines changed

5 files changed

+26
-9
lines changed

coderd/apidoc/docs.go

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

coderd/apidoc/swagger.json

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

coderd/database/dbauthz/dbauthz_test.go

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -987,13 +987,27 @@ func (s *MethodTestSuite) TestOrganization() {
987987
}))
988988
s.Run("PaginatedOrganizationMembers", s.Subtest(func(db database.Store, check *expects) {
989989
o := dbgen.Organization(s.T(), db, database.Organization{})
990+
u := dbgen.User(s.T(), db, database.User{})
991+
mem := dbgen.OrganizationMember(s.T(), db, database.OrganizationMember{
992+
OrganizationID: o.ID,
993+
UserID: u.ID,
994+
Roles: []string{rbac.RoleOrgAdmin()},
995+
})
990996

991997
check.Args(database.PaginatedOrganizationMembersParams{
992998
OrganizationID: o.ID,
993999
LimitOpt: 1,
9941000
}).Asserts(
9951001
rbac.ResourceOrganizationMember.InOrg(o.ID), policy.ActionRead,
996-
)
1002+
).Returns([]database.PaginatedOrganizationMembersRow{
1003+
{OrganizationMember: mem,
1004+
Username: u.Username,
1005+
AvatarURL: u.AvatarURL,
1006+
Name: u.Name,
1007+
Email: u.Email,
1008+
GlobalRoles: u.RBACRoles,
1009+
Count: 1,
1010+
}})
9971011
}))
9981012
s.Run("UpdateMemberRoles", s.Subtest(func(db database.Store, check *expects) {
9991013
o := dbgen.Organization(s.T(), db, database.Organization{})

coderd/members.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ func (api *API) deleteOrganizationMember(rw http.ResponseWriter, r *http.Request
142142
rw.WriteHeader(http.StatusNoContent)
143143
}
144144

145+
// @Deprecated use /organizations/{organization}/paginated-members [get]
145146
// @Summary List organization members
146147
// @ID list-organization-members
147148
// @Security CoderSessionToken
@@ -184,7 +185,7 @@ func (api *API) listMembers(rw http.ResponseWriter, r *http.Request) {
184185
// @Produce json
185186
// @Tags Members
186187
// @Param organization path string true "Organization ID"
187-
// @Param limit query int false "Page limit"
188+
// @Param limit query int false "Page limit, if 0 returns all members"
188189
// @Param offset query int false "Page offset"
189190
// @Success 200 {object} []codersdk.PaginatedMembersResponse
190191
// @Router /organizations/{organization}/paginated-members [get]

docs/reference/api/members.md

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)