fix: update docs

coder · brettkolodny · Mar 10, 2025 · Mar 6, 2025 · Mar 6, 2025 · Mar 6, 2025
commit 737ac9ff89e4ecfbfe238dd964b0e473749daa53
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dbauthz/dbauthz_test.go b/coderd/database/dbauthz/dbauthz_test.go
@@ -987,13 +987,27 @@ func (s *MethodTestSuite) TestOrganization() {
 	}))
 	s.Run("PaginatedOrganizationMembers", s.Subtest(func(db database.Store, check *expects) {
 		o := dbgen.Organization(s.T(), db, database.Organization{})
+		u := dbgen.User(s.T(), db, database.User{})
+		mem := dbgen.OrganizationMember(s.T(), db, database.OrganizationMember{
+			OrganizationID: o.ID,
+			UserID:         u.ID,
+			Roles:          []string{rbac.RoleOrgAdmin()},
+		})
 
 		check.Args(database.PaginatedOrganizationMembersParams{
 			OrganizationID: o.ID,
 			LimitOpt:       1,
 		}).Asserts(
 			rbac.ResourceOrganizationMember.InOrg(o.ID), policy.ActionRead,
-		)
+		).Returns([]database.PaginatedOrganizationMembersRow{
+			{OrganizationMember: mem,
+				Username:    u.Username,
+				AvatarURL:   u.AvatarURL,
+				Name:        u.Name,
+				Email:       u.Email,
+				GlobalRoles: u.RBACRoles,
+				Count:       1,
+			}})
 	}))
 	s.Run("UpdateMemberRoles", s.Subtest(func(db database.Store, check *expects) {
 		o := dbgen.Organization(s.T(), db, database.Organization{})

diff --git a/coderd/members.go b/coderd/members.go
@@ -142,6 +142,7 @@ func (api *API) deleteOrganizationMember(rw http.ResponseWriter, r *http.Request
 	rw.WriteHeader(http.StatusNoContent)
 }
 
+// @Deprecated use /organizations/{organization}/paginated-members [get]
 // @Summary List organization members
 // @ID list-organization-members
 // @Security CoderSessionToken
@@ -184,7 +185,7 @@ func (api *API) listMembers(rw http.ResponseWriter, r *http.Request) {
 // @Produce json
 // @Tags Members
 // @Param organization path string true "Organization ID"
-// @Param limit query int false "Page limit"
+// @Param limit query int false "Page limit, if 0 returns all members"
 // @Param offset query int false "Page offset"
 // @Success 200 {object} []codersdk.PaginatedMembersResponse
 // @Router /organizations/{organization}/paginated-members [get]

diff --git a/docs/reference/api/members.md b/docs/reference/api/members.md