fix: FIT-1348: some API docs paths for Project endpoints are broken (#750)

Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: robot-ci-heartex <robot-ci-heartex@users.noreply.github.com>

Author: robot-ci-heartex

reference.md

@@ -8977,7 +8977,7 @@ client.projects.create()
 <dl>
 <dd>
 
-**control_weights:** `typing.Optional[typing.Any]` — Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+**control_weights:** `typing.Optional[typing.Dict[str, typing.Any]]` — Dict of weights for each control tag in metric calculation.
 
 </dd>
 </dl>
@@ -9663,7 +9663,7 @@ client.projects.update(
 <dl>
 <dd>
 
-**control_weights:** `typing.Optional[typing.Any]` — Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+**control_weights:** `typing.Optional[typing.Dict[str, typing.Any]]` — Dict of weights for each control tag in metric calculation.
 
 </dd>
 </dl>

src/label_studio_sdk/projects/client.py

@@ -161,7 +161,7 @@ def create(
         *,
         annotator_evaluation_enabled: typing.Optional[bool] = OMIT,
         color: typing.Optional[str] = OMIT,
-        control_weights: typing.Optional[typing.Any] = OMIT,
+        control_weights: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
         created_by: typing.Optional[UserSimpleRequest] = OMIT,
         description: typing.Optional[str] = OMIT,
         enable_empty_annotation: typing.Optional[bool] = OMIT,
@@ -201,8 +201,8 @@ def create(
 
         color : typing.Optional[str]
 
-        control_weights : typing.Optional[typing.Any]
-            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+        control_weights : typing.Optional[typing.Dict[str, typing.Any]]
+            Dict of weights for each control tag in metric calculation.
 
         created_by : typing.Optional[UserSimpleRequest]
             Project owner
@@ -498,7 +498,7 @@ def update(
         assignment_settings: typing.Optional[AssignmentSettingsRequest] = OMIT,
         color: typing.Optional[str] = OMIT,
         comment_classification_config: typing.Optional[str] = OMIT,
-        control_weights: typing.Optional[typing.Any] = OMIT,
+        control_weights: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
         created_by: typing.Optional[UserSimpleRequest] = OMIT,
         custom_script: typing.Optional[str] = OMIT,
         custom_task_lock_ttl: typing.Optional[int] = OMIT,
@@ -572,8 +572,8 @@ def update(
 
         comment_classification_config : typing.Optional[str]
 
-        control_weights : typing.Optional[typing.Any]
-            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+        control_weights : typing.Optional[typing.Dict[str, typing.Any]]
+            Dict of weights for each control tag in metric calculation.
 
         created_by : typing.Optional[UserSimpleRequest]
             Project owner
@@ -1232,7 +1232,7 @@ async def create(
         *,
         annotator_evaluation_enabled: typing.Optional[bool] = OMIT,
         color: typing.Optional[str] = OMIT,
-        control_weights: typing.Optional[typing.Any] = OMIT,
+        control_weights: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
         created_by: typing.Optional[UserSimpleRequest] = OMIT,
         description: typing.Optional[str] = OMIT,
         enable_empty_annotation: typing.Optional[bool] = OMIT,
@@ -1272,8 +1272,8 @@ async def create(
 
         color : typing.Optional[str]
 
-        control_weights : typing.Optional[typing.Any]
-            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+        control_weights : typing.Optional[typing.Dict[str, typing.Any]]
+            Dict of weights for each control tag in metric calculation.
 
         created_by : typing.Optional[UserSimpleRequest]
             Project owner
@@ -1601,7 +1601,7 @@ async def update(
         assignment_settings: typing.Optional[AssignmentSettingsRequest] = OMIT,
         color: typing.Optional[str] = OMIT,
         comment_classification_config: typing.Optional[str] = OMIT,
-        control_weights: typing.Optional[typing.Any] = OMIT,
+        control_weights: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
         created_by: typing.Optional[UserSimpleRequest] = OMIT,
         custom_script: typing.Optional[str] = OMIT,
         custom_task_lock_ttl: typing.Optional[int] = OMIT,
@@ -1675,8 +1675,8 @@ async def update(
 
         comment_classification_config : typing.Optional[str]
 
-        control_weights : typing.Optional[typing.Any]
-            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+        control_weights : typing.Optional[typing.Dict[str, typing.Any]]
+            Dict of weights for each control tag in metric calculation.
 
         created_by : typing.Optional[UserSimpleRequest]
             Project owner

src/label_studio_sdk/projects/raw_client.py

@@ -160,7 +160,7 @@ def create(
         *,
         annotator_evaluation_enabled: typing.Optional[bool] = OMIT,
         color: typing.Optional[str] = OMIT,
-        control_weights: typing.Optional[typing.Any] = OMIT,
+        control_weights: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
         created_by: typing.Optional[UserSimpleRequest] = OMIT,
         description: typing.Optional[str] = OMIT,
         enable_empty_annotation: typing.Optional[bool] = OMIT,
@@ -200,8 +200,8 @@ def create(
 
         color : typing.Optional[str]
 
-        control_weights : typing.Optional[typing.Any]
-            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+        control_weights : typing.Optional[typing.Dict[str, typing.Any]]
+            Dict of weights for each control tag in metric calculation.
 
         created_by : typing.Optional[UserSimpleRequest]
             Project owner
@@ -527,7 +527,7 @@ def update(
         assignment_settings: typing.Optional[AssignmentSettingsRequest] = OMIT,
         color: typing.Optional[str] = OMIT,
         comment_classification_config: typing.Optional[str] = OMIT,
-        control_weights: typing.Optional[typing.Any] = OMIT,
+        control_weights: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
         created_by: typing.Optional[UserSimpleRequest] = OMIT,
         custom_script: typing.Optional[str] = OMIT,
         custom_task_lock_ttl: typing.Optional[int] = OMIT,
@@ -601,8 +601,8 @@ def update(
 
         comment_classification_config : typing.Optional[str]
 
-        control_weights : typing.Optional[typing.Any]
-            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+        control_weights : typing.Optional[typing.Dict[str, typing.Any]]
+            Dict of weights for each control tag in metric calculation.
 
         created_by : typing.Optional[UserSimpleRequest]
             Project owner
@@ -1285,7 +1285,7 @@ async def create(
         *,
         annotator_evaluation_enabled: typing.Optional[bool] = OMIT,
         color: typing.Optional[str] = OMIT,
-        control_weights: typing.Optional[typing.Any] = OMIT,
+        control_weights: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
         created_by: typing.Optional[UserSimpleRequest] = OMIT,
         description: typing.Optional[str] = OMIT,
         enable_empty_annotation: typing.Optional[bool] = OMIT,
@@ -1325,8 +1325,8 @@ async def create(
 
         color : typing.Optional[str]
 
-        control_weights : typing.Optional[typing.Any]
-            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+        control_weights : typing.Optional[typing.Dict[str, typing.Any]]
+            Dict of weights for each control tag in metric calculation.
 
         created_by : typing.Optional[UserSimpleRequest]
             Project owner
@@ -1654,7 +1654,7 @@ async def update(
         assignment_settings: typing.Optional[AssignmentSettingsRequest] = OMIT,
         color: typing.Optional[str] = OMIT,
         comment_classification_config: typing.Optional[str] = OMIT,
-        control_weights: typing.Optional[typing.Any] = OMIT,
+        control_weights: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
         created_by: typing.Optional[UserSimpleRequest] = OMIT,
         custom_script: typing.Optional[str] = OMIT,
         custom_task_lock_ttl: typing.Optional[int] = OMIT,
@@ -1728,8 +1728,8 @@ async def update(
 
         comment_classification_config : typing.Optional[str]
 
-        control_weights : typing.Optional[typing.Any]
-            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+        control_weights : typing.Optional[typing.Dict[str, typing.Any]]
+            Dict of weights for each control tag in metric calculation.
 
         created_by : typing.Optional[UserSimpleRequest]
             Project owner

src/label_studio_sdk/types/all_roles_project_list.py

@@ -53,9 +53,9 @@ class AllRolesProjectList(UncheckedBaseModel):
     Flag to detect is project ready for bulk annotation
     """
 
-    control_weights: typing.Optional[typing.Any] = pydantic.Field(default=None)
+    control_weights: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
     """
-    Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+    Dict of weights for each control tag in metric calculation.
     """
 
     created_at: typing.Optional[dt.datetime] = None
@@ -70,7 +70,7 @@ class AllRolesProjectList(UncheckedBaseModel):
     TTL in seconds for task reservations, on new and existing tasks
     """
 
-    data_types: typing.Optional[typing.Any] = None
+    data_types: typing.Optional[typing.Dict[str, typing.Any]] = None
     description: typing.Optional[str] = pydantic.Field(default=None)
     """
     Project description
@@ -141,7 +141,7 @@ class AllRolesProjectList(UncheckedBaseModel):
     num_tasks_with_annotations: typing.Optional[int] = None
     organization: typing.Optional[int] = None
     overlap_cohort_percentage: typing.Optional[int] = None
-    parsed_label_config: typing.Optional[typing.Any] = pydantic.Field(default=None)
+    parsed_label_config: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
     """
     JSON-formatted labeling configuration
     """

src/label_studio_sdk/types/lse_project.py

@@ -50,9 +50,9 @@ class LseProject(UncheckedBaseModel):
     Flag to detect is project ready for bulk annotation
     """
 
-    control_weights: typing.Optional[typing.Any] = pydantic.Field(default=None)
+    control_weights: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
     """
-    Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+    Dict of weights for each control tag in metric calculation.
     """
 
     created_at: typing.Optional[dt.datetime] = None
@@ -67,7 +67,7 @@ class LseProject(UncheckedBaseModel):
     TTL in seconds for task reservations, on new and existing tasks
     """
 
-    data_types: typing.Optional[typing.Any] = None
+    data_types: typing.Optional[typing.Dict[str, typing.Any]] = None
     description: typing.Optional[str] = pydantic.Field(default=None)
     """
     Project description
@@ -141,7 +141,7 @@ class LseProject(UncheckedBaseModel):
     num_tasks_with_annotations: typing.Optional[int] = None
     organization: typing.Optional[int] = None
     overlap_cohort_percentage: typing.Optional[int] = None
-    parsed_label_config: typing.Optional[typing.Any] = pydantic.Field(default=None)
+    parsed_label_config: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
     """
     JSON-formatted labeling configuration
     """

src/label_studio_sdk/types/lse_project_create.py

@@ -33,9 +33,9 @@ class LseProjectCreate(UncheckedBaseModel):
     Flag to detect is project ready for bulk annotation
     """
 
-    control_weights: typing.Optional[typing.Any] = pydantic.Field(default=None)
+    control_weights: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
     """
-    Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+    Dict of weights for each control tag in metric calculation.
     """
 
     created_at: typing.Optional[dt.datetime] = None
@@ -112,7 +112,7 @@ class LseProjectCreate(UncheckedBaseModel):
 
     organization: typing.Optional[int] = None
     overlap_cohort_percentage: typing.Optional[int] = None
-    parsed_label_config: typing.Optional[typing.Any] = pydantic.Field(default=None)
+    parsed_label_config: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
     """
     JSON-formatted labeling configuration
     """

src/label_studio_sdk/types/lse_project_response.py

@@ -50,9 +50,9 @@ class LseProjectResponse(UncheckedBaseModel):
     Flag to detect is project ready for bulk annotation
     """
 
-    control_weights: typing.Optional[typing.Any] = pydantic.Field(default=None)
+    control_weights: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
     """
-    Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+    Dict of weights for each control tag in metric calculation.
     """
 
     created_at: typing.Optional[dt.datetime] = None
@@ -67,7 +67,7 @@ class LseProjectResponse(UncheckedBaseModel):
     TTL in seconds for task reservations, on new and existing tasks
     """
 
-    data_types: typing.Optional[typing.Any] = None
+    data_types: typing.Optional[typing.Dict[str, typing.Any]] = None
     description: typing.Optional[str] = pydantic.Field(default=None)
     """
     Project description
@@ -141,7 +141,7 @@ class LseProjectResponse(UncheckedBaseModel):
     num_tasks_with_annotations: typing.Optional[int] = None
     organization: typing.Optional[int] = None
     overlap_cohort_percentage: typing.Optional[int] = None
-    parsed_label_config: typing.Optional[typing.Any] = pydantic.Field(default=None)
+    parsed_label_config: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
     """
     JSON-formatted labeling configuration
     """