Merge pull request #848 from superannotateai/develop

Develop

Author: VaghinakDev

docs/source/api_reference/api_metadata.rst

@@ -57,6 +57,23 @@ Setting metadata example:
     "value": 3
    }
 
+----------
+
+Workflow metadata
+_________________
+
+Workflow metadata example:
+
+.. code-block:: python
+
+   {
+        "createdAt": "2024-09-03T12:48:09.000Z",
+        "updatedAt": "2024-09-04T12:48:09.000Z",
+        "id": 1,
+        "name": "System workflow",
+        "type": "system",
+        "description": "This workflow is generated by the system, and prevents annotators from completing items."
+    }
 
 ----------
 

src/superannotate/lib/app/interface/sdk_interface.py

@@ -1950,8 +1950,7 @@ def get_project_metadata(
                     "id": 1,
                     "name": "System workflow",
                     "type": "system",
-                    "description": "This workflow is generated by the system, and prevents annotators from completing items.",
-                    "raw_config": {"roles": ["Annotator", "QA"], ...}
+                    "description": "This workflow is generated by the system, and prevents annotators from completing items."
                 },
                 "upload_state": "INITIAL",
                 "contributors": [],
@@ -4533,8 +4532,9 @@ def list_items(
                 - name__starts: str
                 - name__ends: str
                 - annotation_status: str
+                - annotation_status__ne: str
                 - annotation_status__in: list[str]
-                - annotation_status__ne: list[str]
+                - annotation_status__notin: list[str]
                 - approval_status: Literal["Approved", "Disapproved", None]
                 - assignments__user_id: str
                 - assignments__user_id__ne: str
@@ -5815,17 +5815,15 @@ def list_workflows(self):
                     "id": 1,
                     "name": "System workflow",
                     "type": "system",
-                    "description": "This workflow is generated by the system, and prevents annotators from completing items.",
-                    "raw_config": {"roles": ["Annotator", "QA"], ...}
+                    "description": "This workflow is generated by the system, and prevents annotators from completing items."
                 },
                 {
                     "createdAt": "2025-01-03T12:48:09.000Z",
                     "updatedAt": "2025-01-05T12:48:09.000Z",
                     "id": 58758,
                     "name": "Custom workflow",
                     "type": "user",
-                    "description": "This workflow custom build.",
-                    "raw_config": {"roles": ["Custom Annotator", "Custom QA"], ...}
+                    "description": "This workflow custom build."
                 }
             ]
         """

src/superannotate/lib/core/entities/filters.py

@@ -18,7 +18,8 @@ class BaseFilters(TypedDict, total=False):
 class ItemFilters(BaseFilters):
     annotation_status: str | None
     annotation_status__in: list[str] | None
-    annotation_status__ne: list[str] | None
+    annotation_status__ne: str | None
+    annotation_status__notin: list[str] | None
     approval_status: str | None
     approval_status__in: list[str] | None
     approval_status__ne: str | None

src/superannotate/lib/core/entities/project.py

@@ -62,7 +62,6 @@ class WorkflowEntity(TimedBaseModel):
     name: str | None = None
     type: str | None = None
     description: str | None = None
-    raw_config: dict | None = None
 
     def is_system(self):
         return self.type == "system"

tests/integration/items/test_list_items.py

@@ -40,6 +40,25 @@ def test_list_items(self):
         )
         assert len(items) == 100
 
+        assert (
+            len(sa.list_items(self.PROJECT_NAME, annotation_status="NotStarted")) == 100
+        )
+        assert (
+            len(
+                sa.list_items(self.PROJECT_NAME, annotation_status__notin=["Completed"])
+            )
+            == 100
+        )
+        assert (
+            len(
+                sa.list_items(
+                    self.PROJECT_NAME,
+                    annotation_status__notin=["Completed", "NotStarted"],
+                )
+            )
+            == 0
+        )
+
     def test_invalid_filter(self):
         with self.assertRaisesRegex(AppException, "Invalid assignments role provided."):
             sa.list_items(self.PROJECT_NAME, assignments__user_role__in=["Approved"])

tests/integration/projects/test_get_project_metadata.py

@@ -81,7 +81,6 @@ def test_get_project_metadata(self):
             project_metadata["workflow"]["description"]
             == "This workflow is generated by the system, and prevents annotators from completing items."
         )
-        assert project_metadata["workflow"]["raw_config"]
 
     def test_get_project_by_id(self):
         project_metadata = sa.get_project_metadata(self.PROJECT_NAME)

tests/integration/work_management/test_list_workflows.py

@@ -19,4 +19,4 @@ def test_list_workflows(self):
             "This workflow is generated by the "
             "system, and prevents annotators from completing items."
         )
-        assert first_workflow["raw_config"]
+        assert "raw_config" not in first_workflow