From 655b2795f1064f28f7bff6111755a9e4e6ae8877 Mon Sep 17 00:00:00 2001 From: akhil-vamshi-konam Date: Tue, 17 Nov 2026 22:32:10 +0530 Subject: [PATCH 1/2] feat: change a workspace member's role (v1 and v2) --- plane/api/v2/_generated/constants.py | 4 ++++ plane/api/v2/members.py | 22 +++++++++++++++++++--- plane/api/workspaces.py | 16 ++++++++++++++++ plane/models/v2/__init__.py | 2 ++ plane/models/v2/members.py | 8 ++++++++ tests/v2/test_members_resource.py | 25 ++++++++++++++++++++----- 6 files changed, 69 insertions(+), 8 deletions(-) diff --git a/plane/api/v2/_generated/constants.py b/plane/api/v2/_generated/constants.py index 9cf92d4..be4b06a 100644 --- a/plane/api/v2/_generated/constants.py +++ b/plane/api/v2/_generated/constants.py @@ -398,6 +398,7 @@ "workspace_features_retrieve", "workspace_features_update", "workspace_members_list", + "workspace_members_partial_update", "workspace_members_remove", "workspace_pages_create", "workspace_pages_destroy", @@ -5465,6 +5466,7 @@ ] ), "workspace_members_list": frozenset(["all", "id", "member_id", "role"]), + "workspace_members_partial_update": frozenset(["all", "id", "member_id", "role"]), "workspace_pages_create": frozenset( [ "access", @@ -6378,6 +6380,7 @@ "worklogs_partial_update": frozenset(["logged_by"]), "worklogs_retrieve": frozenset(["logged_by"]), "workspace_members_list": frozenset(["member"]), + "workspace_members_partial_update": frozenset(["member"]), "workspace_pages_create": frozenset(["owned_by", "parent"]), "workspace_pages_destroy": frozenset(["owned_by", "parent"]), "workspace_pages_list": frozenset(["owned_by", "parent"]), @@ -10943,6 +10946,7 @@ "updated_at", ] WorkspaceMembersListField = Literal["all", "id", "member_id", "role"] +WorkspaceMembersPartialUpdateField = Literal["all", "id", "member_id", "role"] WorkspacePagesCreateField = Literal[ "access", "all", diff --git a/plane/api/v2/members.py b/plane/api/v2/members.py index f508263..8796d65 100644 --- a/plane/api/v2/members.py +++ b/plane/api/v2/members.py @@ -1,5 +1,5 @@ """Members (api_v2) -- project rosters (full CRUD) and the workspace roster -(list + remove-by-email). Workspace removal is `POST …/members/remove/` keyed +(list, role change, remove-by-email). Workspace removal is `POST …/members/remove/` keyed on `email` (v1 parity), not a detail DELETE keyed on a row id.""" from __future__ import annotations @@ -12,6 +12,7 @@ CreateProjectMember, Member, UpdateProjectMember, + UpdateWorkspaceMember, WorkspaceMemberRemove, ) from ._generated.constants import ( @@ -24,6 +25,7 @@ WorkspaceMembersListField, WorkspaceMembersListFilters, WorkspaceMembersListOrderBy, + WorkspaceMembersPartialUpdateField, ) from ._kernel.pagination import Page, PaginateStyle from ._kernel.resource import V2Resource @@ -156,14 +158,15 @@ def delete(self, slug: str, project: str, member: str) -> None: return self._delete(pk=member, slug=slug, project_id=project) -class WorkspaceMembers(V2Resource[Member, CreateProjectMember, UpdateProjectMember]): - """The workspace roster. List-only plus `remove` -- see the module docstring.""" +class WorkspaceMembers(V2Resource[Member, CreateProjectMember, UpdateWorkspaceMember]): + """The workspace roster: list, a role change, and `remove` -- see the module docstring.""" path = "/workspaces/{slug}/members/" extra_paths = {"remove": "/workspaces/{slug}/members/remove/"} model = Member operations = { "list": "workspace_members_list", + "update": "workspace_members_partial_update", "remove": "workspace_members_remove", } @@ -223,6 +226,19 @@ def iterate( slug=slug, ) + def update( + self, + slug: str, + member: str, + data: UpdateWorkspaceMember, + *, + fields: Sequence[WorkspaceMembersPartialUpdateField] | None = None, + expand: Sequence[str] | None = None, + ) -> Member: + """Change a member's workspace role. `member` is the roster row's `id`, not the user's. + Demoting to `guest` also makes them a guest in every project and drops their teamspaces.""" + return self._update(data, pk=member, params={"fields": fields, "expand": expand}, slug=slug) + def remove(self, slug: str, data: WorkspaceMemberRemove) -> None: """Remove a member from the workspace by email (v1 parity) -- soft-deactivates and cascades out of every project. Not addressed by a diff --git a/plane/api/workspaces.py b/plane/api/workspaces.py index 0cf5a43..fd2fb9d 100644 --- a/plane/api/workspaces.py +++ b/plane/api/workspaces.py @@ -56,6 +56,22 @@ def get_members_lite( ) return PaginatedWorkspaceMemberResponse.model_validate(response) + def update_member_role( + self, workspace_slug: str, member_id: str, role_slug: str + ) -> WorkspaceMember: + """Give a workspace member another role. + + Demoting to ``guest`` also makes them a guest in every project and drops + their teamspaces; a role that needs a seat fails when none is free. + + Args: + workspace_slug: The workspace slug identifier + member_id: The member's user id (the ``id`` that :meth:`get_members` returns) + role_slug: A workspace role's slug, such as admin, member or guest + """ + response = self._patch(f"{workspace_slug}/members/{member_id}", {"role_slug": role_slug}) + return WorkspaceMember.model_validate(response) + def get_project_role_distribution(self, workspace_slug: str) -> ProjectRoleDistribution: """Get the distribution of project members by role across the workspace. diff --git a/plane/models/v2/__init__.py b/plane/models/v2/__init__.py index 9fe9c71..51da7b2 100644 --- a/plane/models/v2/__init__.py +++ b/plane/models/v2/__init__.py @@ -172,6 +172,7 @@ CreateProjectMember, Member, UpdateProjectMember, + UpdateWorkspaceMember, WorkspaceMemberRemove, ) from .milestones import ( @@ -483,6 +484,7 @@ "ProjectFeature", "UpdateProjectFeature", "UpdateProjectMember", + "UpdateWorkspaceMember", "CreateProjectMember", "UpdateProject", "ProjectRoleDistribution", diff --git a/plane/models/v2/members.py b/plane/models/v2/members.py index 3866b8d..a23b3a7 100644 --- a/plane/models/v2/members.py +++ b/plane/models/v2/members.py @@ -37,6 +37,14 @@ class UpdateProjectMember(BaseModel): role: str | None = None +class UpdateWorkspaceMember(BaseModel): + """PATCH body -- change a workspace member's role, by slug (custom roles too).""" + + model_config = ConfigDict(extra="ignore") + + role: str + + class WorkspaceMemberRemove(BaseModel): """POST body for `WorkspaceMembers.remove` (v1 parity) -- removes by email, not by member row id; `remove_seat` additionally frees the license seat.""" diff --git a/tests/v2/test_members_resource.py b/tests/v2/test_members_resource.py index 61b4b7b..f89ef9f 100644 --- a/tests/v2/test_members_resource.py +++ b/tests/v2/test_members_resource.py @@ -9,7 +9,12 @@ from plane.api.v2._kernel.transport import V2Transport from plane.api.v2.members import ProjectMembers, WorkspaceMembers from plane.config import Configuration -from plane.models.v2.members import CreateProjectMember, UpdateProjectMember, WorkspaceMemberRemove +from plane.models.v2.members import ( + CreateProjectMember, + UpdateProjectMember, + UpdateWorkspaceMember, + WorkspaceMemberRemove, +) PROJECT_BASE = "https://api.example.com/api/v2/workspaces/acme/projects/ENG/members" WORKSPACE_BASE = "https://api.example.com/api/v2/workspaces/acme/members" @@ -102,7 +107,7 @@ def test_project_members_delete_returns_none(project_members: ProjectMembers) -> assert responses.calls[0].request.url == f"{PROJECT_BASE}/m1/" -# -- WorkspaceMembers (list-only + remove) ---------------------------------------- +# -- WorkspaceMembers (list, role change, remove) --------------------------------- @responses.activate @@ -134,14 +139,24 @@ def test_workspace_members_list_per_page_and_offset(workspace_members: Workspace @responses.activate def test_workspace_members_has_no_detail_crud(workspace_members: WorkspaceMembers) -> None: - """`WorkspaceMembers` deliberately exposes no `retrieve`/`create`/`update`/ - `delete` -- the golden has no such operations for this resource.""" + """`WorkspaceMembers` deliberately exposes no `retrieve`/`create`/`delete` -- + the golden has no such operations for this resource.""" assert not hasattr(workspace_members, "retrieve") assert not hasattr(workspace_members, "create") - assert not hasattr(workspace_members, "update") assert not hasattr(workspace_members, "delete") +@responses.activate +def test_workspace_members_update_changes_role(workspace_members: WorkspaceMembers) -> None: + responses.patch(f"{WORKSPACE_BASE}/m1/", json={"id": "m1", "member_id": "u1", "role": "guest"}) + + updated = workspace_members.update("acme", "m1", UpdateWorkspaceMember(role="guest")) + + assert updated.role == "guest" + assert responses.calls[0].request.url == f"{WORKSPACE_BASE}/m1/" + assert json.loads(responses.calls[0].request.body) == {"role": "guest"} + + @responses.activate def test_remove_posts_to_remove_sub_path_keyed_by_email( workspace_members: WorkspaceMembers, From e92e5068367181796a78f175f3e4ad337045f51c Mon Sep 17 00:00:00 2001 From: akhil-vamshi-konam Date: Wed, 18 Nov 2026 10:57:03 +0530 Subject: [PATCH 2/2] fix: expose members.update on a loaded workspace --- plane/api/v2/_loaded/workspace.py | 1 + 1 file changed, 1 insertion(+) diff --git a/plane/api/v2/_loaded/workspace.py b/plane/api/v2/_loaded/workspace.py index fa6cf89..3ff40d4 100644 --- a/plane/api/v2/_loaded/workspace.py +++ b/plane/api/v2/_loaded/workspace.py @@ -182,6 +182,7 @@ class _OwnedInvitations(Owned["Invitations"]): class _OwnedWorkspaceMembers(Owned["WorkspaceMembers"]): list = staticmethod(bind1(WorkspaceMembers.list)) iterate = staticmethod(bind1(WorkspaceMembers.iterate)) + update = staticmethod(bind1(WorkspaceMembers.update)) remove = staticmethod(bind1(WorkspaceMembers.remove)) class _OwnedPermissionSchemes(Owned["PermissionSchemes"]):