refactor: Refactored delete pilot endpoints

Author: Robin-Van-de-Merghel

diracx-client/src/diracx/client/_generated/aio/operations/_operations.py

@@ -55,8 +55,8 @@
     build_jobs_unassign_job_sandboxes_request,
     build_pilots_add_jobs_to_pilot_request,
     build_pilots_add_pilot_stamps_request,
-    build_pilots_clear_pilots_request,
     build_pilots_delete_pilots_request,
+    build_pilots_get_pilot_jobs_request,
     build_pilots_search_request,
     build_pilots_update_pilot_fields_request,
     build_well_known_get_installation_metadata_request,
@@ -2294,15 +2294,36 @@ async def add_pilot_stamps(self, body: Union[_models.BodyPilotsAddPilotStamps, I
         return deserialized  # type: ignore
 
     @distributed_trace_async
-    async def delete_pilots(self, *, pilot_stamps: List[str], **kwargs: Any) -> None:
+    async def delete_pilots(
+        self,
+        *,
+        pilot_stamps: Optional[List[str]] = None,
+        age_in_days: Optional[int] = None,
+        delete_only_aborted: bool = False,
+        **kwargs: Any
+    ) -> None:
         """Delete Pilots.
 
         Endpoint to delete a pilot.
 
-        If at least one pilot is not found, it WILL rollback.
+        Two features:
+
 
-        :keyword pilot_stamps: Stamps of the pilots we want to delete. Required.
+        #. Or you provide pilot_stamps, so you can delete pilots by their stamp
+        #. Or you provide age_in_days, so you can delete pilots that lived more than age_in_days days.
+
+        If deleting by stamps, if at least one pilot is not found, it WILL rollback.
+
+        :keyword pilot_stamps: Stamps of the pilots we want to delete. Default value is None.
         :paramtype pilot_stamps: list[str]
+        :keyword age_in_days: The number of days that define the maximum age of pilots to be
+         deleted.Pilots older than this age will be considered for deletion. Default value is None.
+        :paramtype age_in_days: int
+        :keyword delete_only_aborted: Flag indicating whether to only delete pilots whose status is
+         'Aborted'.If set to True, only pilots with the 'Aborted' status will be deleted.It is set by
+         default as True to avoid any mistake.This flag is only used for deletion by time. Default value
+         is False.
+        :paramtype delete_only_aborted: bool
         :return: None
         :rtype: None
         :raises ~azure.core.exceptions.HttpResponseError:
@@ -2322,6 +2343,8 @@ async def delete_pilots(self, *, pilot_stamps: List[str], **kwargs: Any) -> None
 
         _request = build_pilots_delete_pilots_request(
             pilot_stamps=pilot_stamps,
+            age_in_days=age_in_days,
+            delete_only_aborted=delete_only_aborted,
             headers=_headers,
             params=_params,
         )
@@ -2443,20 +2466,15 @@ async def update_pilot_fields(
             return cls(pipeline_response, None, {})  # type: ignore
 
     @distributed_trace_async
-    async def clear_pilots(self, *, age_in_days: int, delete_only_aborted: bool = False, **kwargs: Any) -> None:
-        """Clear Pilots.
+    async def get_pilot_jobs(self, body: str, **kwargs: Any) -> List[int]:
+        """Get Pilot Jobs.
 
-        Endpoint for DIRAC to delete all pilots that lived more than age_in_days.
+        Endpoint only for DIRAC services, to get jobs of a pilot.
 
-        :keyword age_in_days: The number of days that define the maximum age of pilots to be
-         deleted.Pilots older than this age will be considered for deletion. Required.
-        :paramtype age_in_days: int
-        :keyword delete_only_aborted: Flag indicating whether to only delete pilots whose status is
-         'Aborted'.If set to True, only pilots with the 'Aborted' status will be deleted.It is set by
-         default as True to avoid any mistake. Default value is False.
-        :paramtype delete_only_aborted: bool
-        :return: None
-        :rtype: None
+        :param body: Required.
+        :type body: str
+        :return: list of int
+        :rtype: list[int]
         :raises ~azure.core.exceptions.HttpResponseError:
         """
         error_map: MutableMapping = {
@@ -2467,14 +2485,17 @@ async def clear_pilots(self, *, age_in_days: int, delete_only_aborted: bool = Fa
         }
         error_map.update(kwargs.pop("error_map", {}) or {})
 
-        _headers = kwargs.pop("headers", {}) or {}
+        _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
         _params = kwargs.pop("params", {}) or {}
 
-        cls: ClsType[None] = kwargs.pop("cls", None)
+        content_type: str = kwargs.pop("content_type", _headers.pop("Content-Type", "application/json"))
+        cls: ClsType[List[int]] = kwargs.pop("cls", None)
 
-        _request = build_pilots_clear_pilots_request(
-            age_in_days=age_in_days,
-            delete_only_aborted=delete_only_aborted,
+        _content = self._serialize.body(body, "str")
+
+        _request = build_pilots_get_pilot_jobs_request(
+            content_type=content_type,
+            content=_content,
             headers=_headers,
             params=_params,
         )
@@ -2487,12 +2508,16 @@ async def clear_pilots(self, *, age_in_days: int, delete_only_aborted: bool = Fa
 
         response = pipeline_response.http_response
 
-        if response.status_code not in [204]:
+        if response.status_code not in [200]:
             map_error(status_code=response.status_code, response=response, error_map=error_map)
             raise HttpResponseError(response=response)
 
+        deserialized = self._deserialize("[int]", pipeline_response.http_response)
+
         if cls:
-            return cls(pipeline_response, None, {})  # type: ignore
+            return cls(pipeline_response, deserialized, {})  # type: ignore
+
+        return deserialized  # type: ignore
 
     @overload
     async def add_jobs_to_pilot(

diracx-client/src/diracx/client/_generated/models/_models.py

@@ -138,8 +138,14 @@ class BodyPilotsAddPilotStamps(_serialization.Model):
     :vartype vo: str
     :ivar grid_type: Grid type of the pilots.
     :vartype grid_type: str
+    :ivar grid_site: Pilots grid site.
+    :vartype grid_site: str
+    :ivar destination_site: Pilots destination site.
+    :vartype destination_site: str
     :ivar pilot_references: Association of a pilot reference with a pilot stamp.
     :vartype pilot_references: dict[str, str]
+    :ivar status_reason: Status reason of the pilots.
+    :vartype status_reason: str
     """
 
     _validation = {
@@ -151,7 +157,10 @@ class BodyPilotsAddPilotStamps(_serialization.Model):
         "pilot_stamps": {"key": "pilot_stamps", "type": "[str]"},
         "vo": {"key": "vo", "type": "str"},
         "grid_type": {"key": "grid_type", "type": "str"},
+        "grid_site": {"key": "grid_site", "type": "str"},
+        "destination_site": {"key": "destination_site", "type": "str"},
         "pilot_references": {"key": "pilot_references", "type": "{str}"},
+        "status_reason": {"key": "status_reason", "type": "str"},
     }
 
     def __init__(
@@ -160,7 +169,10 @@ def __init__(
         pilot_stamps: List[str],
         vo: str,
         grid_type: str = "Dirac",
+        grid_site: str = "Unknown",
+        destination_site: str = "NotAssigned",
         pilot_references: Optional[Dict[str, str]] = None,
+        status_reason: str = "Unknown",
         **kwargs: Any
     ) -> None:
         """
@@ -170,14 +182,23 @@ def __init__(
         :paramtype vo: str
         :keyword grid_type: Grid type of the pilots.
         :paramtype grid_type: str
+        :keyword grid_site: Pilots grid site.
+        :paramtype grid_site: str
+        :keyword destination_site: Pilots destination site.
+        :paramtype destination_site: str
         :keyword pilot_references: Association of a pilot reference with a pilot stamp.
         :paramtype pilot_references: dict[str, str]
+        :keyword status_reason: Status reason of the pilots.
+        :paramtype status_reason: str
         """
         super().__init__(**kwargs)
         self.pilot_stamps = pilot_stamps
         self.vo = vo
         self.grid_type = grid_type
+        self.grid_site = grid_site
+        self.destination_site = destination_site
         self.pilot_references = pilot_references
+        self.status_reason = status_reason
 
 
 class BodyPilotsUpdatePilotFields(_serialization.Model):

diracx-client/src/diracx/client/_generated/operations/_operations.py

@@ -601,7 +601,7 @@ def build_pilots_add_pilot_stamps_request(**kwargs: Any) -> HttpRequest:
     accept = _headers.pop("Accept", "application/json")
 
     # Construct URL
-    _url = "/api/pilots/management/pilot"
+    _url = "/api/pilots/"
 
     # Construct headers
     if content_type is not None:
@@ -611,14 +611,25 @@ def build_pilots_add_pilot_stamps_request(**kwargs: Any) -> HttpRequest:
     return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs)
 
 
-def build_pilots_delete_pilots_request(*, pilot_stamps: List[str], **kwargs: Any) -> HttpRequest:
+def build_pilots_delete_pilots_request(
+    *,
+    pilot_stamps: Optional[List[str]] = None,
+    age_in_days: Optional[int] = None,
+    delete_only_aborted: bool = False,
+    **kwargs: Any
+) -> HttpRequest:
     _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
 
     # Construct URL
-    _url = "/api/pilots/management/pilot"
+    _url = "/api/pilots/"
 
     # Construct parameters
-    _params["pilot_stamps"] = _SERIALIZER.query("pilot_stamps", pilot_stamps, "[str]")
+    if pilot_stamps is not None:
+        _params["pilot_stamps"] = _SERIALIZER.query("pilot_stamps", pilot_stamps, "[str]")
+    if age_in_days is not None:
+        _params["age_in_days"] = _SERIALIZER.query("age_in_days", age_in_days, "int")
+    if delete_only_aborted is not None:
+        _params["delete_only_aborted"] = _SERIALIZER.query("delete_only_aborted", delete_only_aborted, "bool")
 
     return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs)
 
@@ -628,7 +639,7 @@ def build_pilots_update_pilot_fields_request(**kwargs: Any) -> HttpRequest:
 
     content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
     # Construct URL
-    _url = "/api/pilots/management/pilot"
+    _url = "/api/pilots/metadata"
 
     # Construct headers
     if content_type is not None:
@@ -637,28 +648,29 @@ def build_pilots_update_pilot_fields_request(**kwargs: Any) -> HttpRequest:
     return HttpRequest(method="PATCH", url=_url, headers=_headers, **kwargs)
 
 
-def build_pilots_clear_pilots_request(
-    *, age_in_days: int, delete_only_aborted: bool = False, **kwargs: Any
-) -> HttpRequest:
-    _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
+def build_pilots_get_pilot_jobs_request(*, content: str, **kwargs: Any) -> HttpRequest:
+    _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
+
+    content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
+    accept = _headers.pop("Accept", "application/json")
 
     # Construct URL
-    _url = "/api/pilots/management/pilot/interval"
+    _url = "/api/pilots/jobs"
 
-    # Construct parameters
-    _params["age_in_days"] = _SERIALIZER.query("age_in_days", age_in_days, "int")
-    if delete_only_aborted is not None:
-        _params["delete_only_aborted"] = _SERIALIZER.query("delete_only_aborted", delete_only_aborted, "bool")
+    # Construct headers
+    if content_type is not None:
+        _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str")
+    _headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
 
-    return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs)
+    return HttpRequest(method="GET", url=_url, headers=_headers, content=content, **kwargs)
 
 
 def build_pilots_add_jobs_to_pilot_request(**kwargs: Any) -> HttpRequest:
     _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
 
     content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
     # Construct URL
-    _url = "/api/pilots/management/jobs"
+    _url = "/api/pilots/jobs"
 
     # Construct headers
     if content_type is not None:
@@ -2913,16 +2925,35 @@ def add_pilot_stamps(self, body: Union[_models.BodyPilotsAddPilotStamps, IO[byte
 
     @distributed_trace
     def delete_pilots(  # pylint: disable=inconsistent-return-statements
-        self, *, pilot_stamps: List[str], **kwargs: Any
+        self,
+        *,
+        pilot_stamps: Optional[List[str]] = None,
+        age_in_days: Optional[int] = None,
+        delete_only_aborted: bool = False,
+        **kwargs: Any
     ) -> None:
         """Delete Pilots.
 
         Endpoint to delete a pilot.
 
-        If at least one pilot is not found, it WILL rollback.
+        Two features:
+
 
-        :keyword pilot_stamps: Stamps of the pilots we want to delete. Required.
+        #. Or you provide pilot_stamps, so you can delete pilots by their stamp
+        #. Or you provide age_in_days, so you can delete pilots that lived more than age_in_days days.
+
+        If deleting by stamps, if at least one pilot is not found, it WILL rollback.
+
+        :keyword pilot_stamps: Stamps of the pilots we want to delete. Default value is None.
         :paramtype pilot_stamps: list[str]
+        :keyword age_in_days: The number of days that define the maximum age of pilots to be
+         deleted.Pilots older than this age will be considered for deletion. Default value is None.
+        :paramtype age_in_days: int
+        :keyword delete_only_aborted: Flag indicating whether to only delete pilots whose status is
+         'Aborted'.If set to True, only pilots with the 'Aborted' status will be deleted.It is set by
+         default as True to avoid any mistake.This flag is only used for deletion by time. Default value
+         is False.
+        :paramtype delete_only_aborted: bool
         :return: None
         :rtype: None
         :raises ~azure.core.exceptions.HttpResponseError:
@@ -2942,6 +2973,8 @@ def delete_pilots(  # pylint: disable=inconsistent-return-statements
 
         _request = build_pilots_delete_pilots_request(
             pilot_stamps=pilot_stamps,
+            age_in_days=age_in_days,
+            delete_only_aborted=delete_only_aborted,
             headers=_headers,
             params=_params,
         )
@@ -3061,22 +3094,15 @@ def update_pilot_fields(  # pylint: disable=inconsistent-return-statements
             return cls(pipeline_response, None, {})  # type: ignore
 
     @distributed_trace
-    def clear_pilots(  # pylint: disable=inconsistent-return-statements
-        self, *, age_in_days: int, delete_only_aborted: bool = False, **kwargs: Any
-    ) -> None:
-        """Clear Pilots.
+    def get_pilot_jobs(self, body: str, **kwargs: Any) -> List[int]:
+        """Get Pilot Jobs.
 
-        Endpoint for DIRAC to delete all pilots that lived more than age_in_days.
+        Endpoint only for DIRAC services, to get jobs of a pilot.
 
-        :keyword age_in_days: The number of days that define the maximum age of pilots to be
-         deleted.Pilots older than this age will be considered for deletion. Required.
-        :paramtype age_in_days: int
-        :keyword delete_only_aborted: Flag indicating whether to only delete pilots whose status is
-         'Aborted'.If set to True, only pilots with the 'Aborted' status will be deleted.It is set by
-         default as True to avoid any mistake. Default value is False.
-        :paramtype delete_only_aborted: bool
-        :return: None
-        :rtype: None
+        :param body: Required.
+        :type body: str
+        :return: list of int
+        :rtype: list[int]
         :raises ~azure.core.exceptions.HttpResponseError:
         """
         error_map: MutableMapping = {
@@ -3087,14 +3113,17 @@ def clear_pilots(  # pylint: disable=inconsistent-return-statements
         }
         error_map.update(kwargs.pop("error_map", {}) or {})
 
-        _headers = kwargs.pop("headers", {}) or {}
+        _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
         _params = kwargs.pop("params", {}) or {}
 
-        cls: ClsType[None] = kwargs.pop("cls", None)
+        content_type: str = kwargs.pop("content_type", _headers.pop("Content-Type", "application/json"))
+        cls: ClsType[List[int]] = kwargs.pop("cls", None)
 
-        _request = build_pilots_clear_pilots_request(
-            age_in_days=age_in_days,
-            delete_only_aborted=delete_only_aborted,
+        _content = self._serialize.body(body, "str")
+
+        _request = build_pilots_get_pilot_jobs_request(
+            content_type=content_type,
+            content=_content,
             headers=_headers,
             params=_params,
         )
@@ -3107,12 +3136,16 @@ def clear_pilots(  # pylint: disable=inconsistent-return-statements
 
         response = pipeline_response.http_response
 
-        if response.status_code not in [204]:
+        if response.status_code not in [200]:
             map_error(status_code=response.status_code, response=response, error_map=error_map)
             raise HttpResponseError(response=response)
 
+        deserialized = self._deserialize("[int]", pipeline_response.http_response)
+
         if cls:
-            return cls(pipeline_response, None, {})  # type: ignore
+            return cls(pipeline_response, deserialized, {})  # type: ignore
+
+        return deserialized  # type: ignore
 
     @overload
     def add_jobs_to_pilot(