fix: BROS-197: Add missing parameters for /api/projects (#492)

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

Author: 3 people

.mock/definition/projects.yml

@@ -1,6 +1,12 @@
-imports:
-  root: __package__.yml
 types:
+  ProjectsListRequestFilter:
+    enum:
+      - all
+      - pinned_only
+      - exclude_pinned
+    default: all
+    source:
+      openapi: openapi/openapi.yaml
   ProjectsListResponse:
     properties:
       count: integer
@@ -163,6 +169,8 @@ types:
         docs: The list of found data columns
     source:
       openapi: openapi/openapi.yaml
+imports:
+  root: __package__.yml
 service:
   auth: false
   base-path: ''
@@ -221,11 +229,30 @@ service:
           workspaces:
             type: optional<integer>
             docs: workspaces
+          include:
+            type: optional<string>
+            docs: >
+              Comma-separated list of count fields to include in the response to
+              optimize performance.  Available fields: task_number,
+              finished_task_number, total_predictions_number, 
+              total_annotations_number, num_tasks_with_annotations,
+              useful_annotation_number,  ground_truth_number,
+              skipped_annotations_number. If not specified, all count fields are
+              included.
+          filter:
+            type: optional<ProjectsListRequestFilter>
+            default: all
+            docs: >
+              Filter projects by pinned status. Use 'pinned_only' to return only
+              pinned projects,  'exclude_pinned' to return only non-pinned
+              projects, or 'all' to return all projects.
       response:
         docs: ''
         type: ProjectsListResponse
       examples:
-        - response:
+        - query-parameters:
+            include: task_number,total_annotations_number,num_tasks_with_annotations
+          response:
             body:
               count: 1
               next: next

poetry.lock

@@ -3712,7 +3712,9 @@ from label_studio_sdk import LabelStudio
 client = LabelStudio(
     api_key="YOUR_API_KEY",
 )
-response = client.projects.list()
+response = client.projects.list(
+    include="task_number,total_annotations_number,num_tasks_with_annotations",
+)
 for item in response:
     yield item
 # alternatively, you can paginate page-by-page
@@ -3781,6 +3783,22 @@ for page in response.iter_pages():
 <dl>
 <dd>
 
+**include:** `typing.Optional[str]` — Comma-separated list of count fields to include in the response to optimize performance.  Available fields: task_number, finished_task_number, total_predictions_number,  total_annotations_number, num_tasks_with_annotations, useful_annotation_number,  ground_truth_number, skipped_annotations_number. If not specified, all count fields are included.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**filter:** `typing.Optional[ProjectsListRequestFilter]` — Filter projects by pinned status. Use 'pinned_only' to return only pinned projects,  'exclude_pinned' to return only non-pinned projects, or 'all' to return all projects.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
 
 </dd>

reference.md

@@ -159,7 +159,13 @@
     MlUpdateResponse,
     MlUpdateResponseAuthMethod,
 )
-from .projects import ProjectsCreateResponse, ProjectsImportTasksResponse, ProjectsListResponse, ProjectsUpdateResponse
+from .projects import (
+    ProjectsCreateResponse,
+    ProjectsImportTasksResponse,
+    ProjectsListRequestFilter,
+    ProjectsListResponse,
+    ProjectsUpdateResponse,
+)
 from .prompts import (
     PromptsBatchFailedPredictionsRequestFailedPredictionsItem,
     PromptsBatchFailedPredictionsResponse,
@@ -293,6 +299,7 @@
     "ProjectSkipQueue",
     "ProjectsCreateResponse",
     "ProjectsImportTasksResponse",
+    "ProjectsListRequestFilter",
     "ProjectsListResponse",
     "ProjectsUpdateResponse",
     "Prompt",

src/label_studio_sdk/__init__.py

@@ -1,6 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from .types import ProjectsCreateResponse, ProjectsImportTasksResponse, ProjectsListResponse, ProjectsUpdateResponse
+from .types import (
+    ProjectsCreateResponse,
+    ProjectsImportTasksResponse,
+    ProjectsListRequestFilter,
+    ProjectsListResponse,
+    ProjectsUpdateResponse,
+)
 from . import exports, pauses
 from .exports import ExportsConvertResponse, ExportsListFormatsResponseItem
 
@@ -9,6 +15,7 @@
     "ExportsListFormatsResponseItem",
     "ProjectsCreateResponse",
     "ProjectsImportTasksResponse",
+    "ProjectsListRequestFilter",
     "ProjectsListResponse",
     "ProjectsUpdateResponse",
     "exports",

src/label_studio_sdk/projects/__init__.py

@@ -4,6 +4,7 @@
 from ..core.client_wrapper import SyncClientWrapper
 from .pauses.client import PausesClient
 from .exports.client import ExportsClient
+from .types.projects_list_request_filter import ProjectsListRequestFilter
 from ..core.request_options import RequestOptions
 from ..core.pagination import SyncPager
 from ..types.project import Project
@@ -41,6 +42,8 @@ def list(
         page: typing.Optional[int] = None,
         page_size: typing.Optional[int] = None,
         workspaces: typing.Optional[int] = None,
+        include: typing.Optional[str] = None,
+        filter: typing.Optional[ProjectsListRequestFilter] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SyncPager[Project]:
         """
@@ -75,6 +78,12 @@ def list(
         workspaces : typing.Optional[int]
             workspaces
 
+        include : typing.Optional[str]
+            Comma-separated list of count fields to include in the response to optimize performance.  Available fields: task_number, finished_task_number, total_predictions_number,  total_annotations_number, num_tasks_with_annotations, useful_annotation_number,  ground_truth_number, skipped_annotations_number. If not specified, all count fields are included.
+
+        filter : typing.Optional[ProjectsListRequestFilter]
+            Filter projects by pinned status. Use 'pinned_only' to return only pinned projects,  'exclude_pinned' to return only non-pinned projects, or 'all' to return all projects.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -90,7 +99,9 @@ def list(
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        response = client.projects.list()
+        response = client.projects.list(
+            include="task_number,total_annotations_number,num_tasks_with_annotations",
+        )
         for item in response:
             yield item
         # alternatively, you can paginate page-by-page
@@ -108,6 +119,8 @@ def list(
                 "page": page,
                 "page_size": page_size,
                 "workspaces": workspaces,
+                "include": include,
+                "filter": filter,
             },
             request_options=request_options,
         )
@@ -128,6 +141,8 @@ def list(
                     page=page + 1,
                     page_size=page_size,
                     workspaces=workspaces,
+                    include=include,
+                    filter=filter,
                     request_options=request_options,
                 )
                 _items = _parsed_response.results
@@ -714,6 +729,8 @@ async def list(
         page: typing.Optional[int] = None,
         page_size: typing.Optional[int] = None,
         workspaces: typing.Optional[int] = None,
+        include: typing.Optional[str] = None,
+        filter: typing.Optional[ProjectsListRequestFilter] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncPager[Project]:
         """
@@ -748,6 +765,12 @@ async def list(
         workspaces : typing.Optional[int]
             workspaces
 
+        include : typing.Optional[str]
+            Comma-separated list of count fields to include in the response to optimize performance.  Available fields: task_number, finished_task_number, total_predictions_number,  total_annotations_number, num_tasks_with_annotations, useful_annotation_number,  ground_truth_number, skipped_annotations_number. If not specified, all count fields are included.
+
+        filter : typing.Optional[ProjectsListRequestFilter]
+            Filter projects by pinned status. Use 'pinned_only' to return only pinned projects,  'exclude_pinned' to return only non-pinned projects, or 'all' to return all projects.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -768,7 +791,9 @@ async def list(
 
 
         async def main() -> None:
-            response = await client.projects.list()
+            response = await client.projects.list(
+                include="task_number,total_annotations_number,num_tasks_with_annotations",
+            )
             async for item in response:
                 yield item
             # alternatively, you can paginate page-by-page
@@ -789,6 +814,8 @@ async def main() -> None:
                 "page": page,
                 "page_size": page_size,
                 "workspaces": workspaces,
+                "include": include,
+                "filter": filter,
             },
             request_options=request_options,
         )
@@ -809,6 +836,8 @@ async def main() -> None:
                     page=page + 1,
                     page_size=page_size,
                     workspaces=workspaces,
+                    include=include,
+                    filter=filter,
                     request_options=request_options,
                 )
                 _items = _parsed_response.results

src/label_studio_sdk/projects/client.py

@@ -15,11 +15,11 @@ def __init__(self, export_snapshot):
         super().__init__(
             status_code=500,
             body=(
-                f"Export job timed out after {timeout} seconds: "
+                f"Export job timed out: "
                 f"unable to retrieve export job {export_snapshot.id}. "
                 f"Current status: {export_snapshot.status}. "
                 f"Try manually checking the running job with "
-                f"`ls.projects.exports.get(project_id={project_id}, export_pk={export_snapshot.id})`."
+                f"`ls.projects.exports.get(id=<PROJECT_ID>, export_pk={export_snapshot.id})`."
             )
         )
 

src/label_studio_sdk/projects/exports/client_ext.py

@@ -2,7 +2,14 @@
 
 from .projects_create_response import ProjectsCreateResponse
 from .projects_import_tasks_response import ProjectsImportTasksResponse
+from .projects_list_request_filter import ProjectsListRequestFilter
 from .projects_list_response import ProjectsListResponse
 from .projects_update_response import ProjectsUpdateResponse
 
-__all__ = ["ProjectsCreateResponse", "ProjectsImportTasksResponse", "ProjectsListResponse", "ProjectsUpdateResponse"]
+__all__ = [
+    "ProjectsCreateResponse",
+    "ProjectsImportTasksResponse",
+    "ProjectsListRequestFilter",
+    "ProjectsListResponse",
+    "ProjectsUpdateResponse",
+]

src/label_studio_sdk/projects/types/__init__.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ProjectsListRequestFilter = typing.Union[typing.Literal["all", "pinned_only", "exclude_pinned"], typing.Any]

src/label_studio_sdk/projects/types/projects_list_request_filter.py

@@ -115,7 +115,6 @@ def refresh(self) -> AccessTokenResponse:
 
         # For sync client, use it directly
         if isinstance(existing_client, httpx.Client):
-            print(f"\nverify:{existing_client._transport._pool._ssl_context.verify_mode != ssl.CERT_NONE}")
             response = existing_client.request(
                 method="POST",
                 url=f"{self._base_url}/api/token/refresh/",