feat: FIT-582: Members Page performance improvement to display only users with contributions (#536)

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: hakan458 <[email protected]>

Author: 3 people

.mock/definition/projects.yml

@@ -969,25 +969,6 @@ service:
               task_count: 1
       audiences:
         - public
-    api_projects_members_retrieve:
-      path: /api/projects/{id}/members/
-      method: GET
-      auth: true
-      docs: Retrieve the members for a specific project.
-      source:
-        openapi: openapi/openapi.yaml
-      path-parameters:
-        id: integer
-      display-name: Get project members
-      response:
-        docs: ''
-        type: root.ProjectMember
-      examples:
-        - path-parameters:
-            id: 1
-          response:
-            body:
-              user: 1
     api_projects_members_create:
       path: /api/projects/{id}/members/
       method: POST

.mock/definition/projects/members.yml

@@ -0,0 +1,72 @@
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    get:
+      path: /api/projects/{id}/members/
+      method: GET
+      auth: true
+      docs: >-
+        Retrieve the members for a specific project. Optionally filter by user
+        IDs (comma-separated).
+      source:
+        openapi: openapi/openapi.yaml
+      path-parameters:
+        id: integer
+      display-name: Get project members
+      request:
+        name: MembersGetRequest
+        query-parameters:
+          user_ids:
+            type: optional<string>
+            docs: >-
+              Comma-separated list of user IDs to include. Example:
+              user_ids=1,2,3
+      response:
+        docs: List of users with membership information
+        type: list<root.LseUser>
+      examples:
+        - path-parameters:
+            id: 1
+          response:
+            body:
+              - active_organization: 1
+                active_organization_meta: active_organization_meta
+                allow_newsletters: true
+                avatar: avatar
+                custom_hotkeys:
+                  key: value
+                date_joined: '2024-01-15T09:30:00Z'
+                email: email
+                first_name: first_name
+                id: 1
+                initials: initials
+                last_activity: '2024-01-15T09:30:00Z'
+                last_name: last_name
+                lse_fields:
+                  email_notification_settings: email_notification_settings
+                  invite_activated: true
+                  invite_expired: invite_expired
+                  invite_expired_at: invite_expired_at
+                  invited_at: '2024-01-15T09:30:00Z'
+                  invited_by: 1
+                  onboarding_state: not_started
+                  social_auth_finished: true
+                  trial_company: trial_company
+                  trial_experience_labeling: trial_experience_labeling
+                  trial_license_enterprise: true
+                  trial_models_in_production: trial_models_in_production
+                  trial_role: annotator
+                org_membership:
+                  - active: active
+                    organization_id: 1
+                    role: role
+                pause: pause
+                phone: phone
+                username: username
+      audiences:
+        - public
+  source:
+    openapi: openapi/openapi.yaml

.mock/openapi/openapi.yaml

@@ -7106,26 +7106,39 @@ paths:
       tags:
         - Projects
     get:
-      description: Retrieve the members for a specific project.
+      description: Retrieve the members for a specific project. Optionally filter by user IDs (comma-separated).
       operationId: api_projects_members_retrieve
       parameters:
         - in: path
           name: id
           required: true
           schema:
             type: integer
+        - description: 'Comma-separated list of user IDs to include. Example: user_ids=1,2,3'
+          in: query
+          name: user_ids
+          schema:
+            type: string
       responses:
         '200':
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ProjectMember'
-          description: ''
+                items:
+                  $ref: '#/components/schemas/LseUser'
+                type: array
+          description: List of users with membership information
       security:
         - Token: []
       summary: Get project members
       tags:
         - Projects
+      x-fern-audiences:
+        - public
+      x-fern-sdk-group-name:
+        - projects
+        - members
+      x-fern-sdk-method-name: get
     post:
       description: Add a member to a specific project.
       operationId: api_projects_members_create

poetry.lock

@@ -20265,6 +20265,85 @@ client.projects.exports.convert(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Projects Members
+<details><summary><code>client.projects.members.<a href="src/label_studio_sdk/projects/members/client.py">get</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve the members for a specific project. Optionally filter by user IDs (comma-separated).
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from label_studio_sdk import LabelStudio
+
+client = LabelStudio(
+    api_key="YOUR_API_KEY",
+)
+client.projects.members.get(
+    id=1,
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `int` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**user_ids:** `typing.Optional[str]` — Comma-separated list of user IDs to include. Example: user_ids=1,2,3
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>

reference.md

@@ -9,7 +9,7 @@
     ProjectsImportTasksResponse,
     ProjectsListRequestFilter,
 )
-from . import assignments, exports, pauses, stats
+from . import assignments, exports, members, pauses, stats
 from .assignments import (
     AssignmentsAssignRequestType,
     AssignmentsBulkAssignRequestFilters,
@@ -58,6 +58,7 @@
     "StatsIaaResponseStd",
     "assignments",
     "exports",
+    "members",
     "pauses",
     "stats",
 ]

src/label_studio_sdk/projects/__init__.py

@@ -3,6 +3,7 @@
 import typing
 from ..core.client_wrapper import SyncClientWrapper
 from .exports.client import ExportsClient
+from .members.client import MembersClient
 from .stats.client import StatsClient
 from .assignments.client import AssignmentsClient
 from .pauses.client import PausesClient
@@ -35,6 +36,7 @@
 from ..types.project_label_config import ProjectLabelConfig
 from ..core.client_wrapper import AsyncClientWrapper
 from .exports.client import AsyncExportsClient
+from .members.client import AsyncMembersClient
 from .stats.client import AsyncStatsClient
 from .assignments.client import AsyncAssignmentsClient
 from .pauses.client import AsyncPausesClient
@@ -48,6 +50,7 @@ class ProjectsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
         self.exports = ExportsClient(client_wrapper=self._client_wrapper)
+        self.members = MembersClient(client_wrapper=self._client_wrapper)
         self.stats = StatsClient(client_wrapper=self._client_wrapper)
         self.assignments = AssignmentsClient(client_wrapper=self._client_wrapper)
         self.pauses = PausesClient(client_wrapper=self._client_wrapper)
@@ -976,6 +979,7 @@ class AsyncProjectsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
         self.exports = AsyncExportsClient(client_wrapper=self._client_wrapper)
+        self.members = AsyncMembersClient(client_wrapper=self._client_wrapper)
         self.stats = AsyncStatsClient(client_wrapper=self._client_wrapper)
         self.assignments = AsyncAssignmentsClient(client_wrapper=self._client_wrapper)
         self.pauses = AsyncPausesClient(client_wrapper=self._client_wrapper)

src/label_studio_sdk/projects/client.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+