Added deprecation TODO comments to bulk async skeleton GET endpoints.

caveclient/endpoints.py

@@ -320,8 +320,12 @@
     + "/{datastack_name}/bulk/get_skeletons/{output_format}/{gen_missing_sks}/{root_ids}",
     "get_bulk_skeletons_via_skvn_rids": skeleton_v1
     + "/{datastack_name}/bulk/get_skeletons/{skeleton_version}/{output_format}/{gen_missing_sks}/{root_ids}",
+    # DEPRECATED: This endpoint is deprecated and will be removed in the future.
+    # Please use the POST endpoint in the future.
     "gen_bulk_skeletons_via_rids": skeleton_v1
     + "/{datastack_name}/bulk/gen_skeletons/{root_ids}",
+    # DEPRECATED: This endpoint is deprecated and will be removed in the future.
+    # Please use the POST endpoint in the future.
     "gen_bulk_skeletons_via_skvn_rids": skeleton_v1
     + "/{datastack_name}/bulk/gen_skeletons/{skeleton_version}/{root_ids}",
     "gen_bulk_skeletons_via_rids_as_post": skeleton_v1

caveclient/skeletonservice.py

@@ -307,19 +307,21 @@
 
         endpoint_mapping = self.default_url_mapping
         endpoint_mapping["datastack_name"] = datastack_name
         if not post:
+            # DEPRECATED: This endpoint is deprecated and will be removed in the future.
+            # Please use the POST endpoint in the future.
             endpoint_mapping["root_ids"] = ",".join([str(v) for v in root_ids])
 
             if not skeleton_version:
                 endpoint = "gen_bulk_skeletons_via_rids"
             else:
                 endpoint_mapping["skeleton_version"] = skeleton_version
                 endpoint = "gen_bulk_skeletons_via_skvn_rids"
         else:
             if not skeleton_version:
                 endpoint = "gen_bulk_skeletons_via_rids_as_post"
             else:
                 endpoint = "gen_bulk_skeletons_via_skvn_rids_as_post"
 
         url = self._endpoints[endpoint].format_map(endpoint_mapping)
         return url
@@ -703,7 +705,7 @@
             root_ids = root_ids[:MAX_BULK_ASYNCHRONOUS_SKELETONS]
 
         # TODO: I recently converted this function to a batched approach to alleviate sending a long URL of root_ids via GET,
-        # but has since converted the call to POST, which probably obviates the need for the considerably more complex batch handling.
+        # but have since converted the call to POST, which probably obviates the need for the considerably more complex batch handling.
         # So consider reverting to the unbatched approach in the future.
 
         estimated_async_time_secs_upper_bound_sum = 0
@@ -713,12 +715,12 @@
             url = self._build_bulk_async_endpoint(
                 rids_one_batch, datastack_name, skeleton_version, post=True
             )
             data = {
                 "root_ids": rids_one_batch,
                 "skeleton_version": skeleton_version,
             }
             response = self.session.post(url, json=data)
             response = handle_response(response, as_json=False)
 
             estimated_async_time_secs_upper_bound = float(response.text)
             estimated_async_time_secs_upper_bound_sum += (
@@ -750,7 +752,7 @@
         # else:
         #     estimate_time_str = f"{(estimated_async_time_secs_upper_bound_sum / 86400):.2f} days"
 
         logging.info(
             f"Upper estimate to generate all {len(root_ids)} skeletons: {estimate_time_str}"
         )
         return estimated_async_time_secs_upper_bound_sum