fix: change endpoint and add documentation

Author: TheauW

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

@@ -1186,13 +1186,13 @@ async def get_sandbox_file(self, *, pfn: str, **kwargs: Any) -> _models.SandboxD
         return deserialized  # type: ignore
 
     @distributed_trace_async
-    async def unassign_bulk_jobs_sandboxes(self, *, jobs_ids: List[int], **kwargs: Any) -> Any:
+    async def unassign_bulk_jobs_sandboxes(self, *, job_ids: List[int], **kwargs: Any) -> Any:
         """Unassign Bulk Jobs Sandboxes.
 
         Delete bulk jobs sandbox mapping.
 
-        :keyword jobs_ids: Required.
-        :paramtype jobs_ids: list[int]
+        :keyword job_ids: Required.
+        :paramtype job_ids: list[int]
         :return: any
         :rtype: any
         :raises ~azure.core.exceptions.HttpResponseError:
@@ -1211,7 +1211,7 @@ async def unassign_bulk_jobs_sandboxes(self, *, jobs_ids: List[int], **kwargs: A
         cls: ClsType[Any] = kwargs.pop("cls", None)
 
         _request = build_jobs_unassign_bulk_jobs_sandboxes_request(
-            jobs_ids=jobs_ids,
+            job_ids=job_ids,
             headers=_headers,
             params=_params,
         )
@@ -1458,7 +1458,15 @@ async def set_job_statuses(
     ) -> _models.SetJobStatusReturn:
         """Set Job Statuses.
 
-        Set Job Statuses.
+        Set the status of a job or a list of jobs.
+
+        Body parameters:
+
+
+        * ``Status``\\ : The new status of the job.
+        * ``MinorStatus``\\ : The minor status of the job.
+        * ``ApplicationStatus``\\ : The application-specific status of the job.
+        * ``Source``\\ : The source of the status update (default is "Unknown").
 
         :param body: Required.
         :type body: dict[str, dict[str, ~_generated.models.JobStatusUpdate]]
@@ -1478,7 +1486,15 @@ async def set_job_statuses(
     ) -> _models.SetJobStatusReturn:
         """Set Job Statuses.
 
-        Set Job Statuses.
+        Set the status of a job or a list of jobs.
+
+        Body parameters:
+
+
+        * ``Status``\\ : The new status of the job.
+        * ``MinorStatus``\\ : The minor status of the job.
+        * ``ApplicationStatus``\\ : The application-specific status of the job.
+        * ``Source``\\ : The source of the status update (default is "Unknown").
 
         :param body: Required.
         :type body: IO[bytes]
@@ -1502,7 +1518,15 @@ async def set_job_statuses(
     ) -> _models.SetJobStatusReturn:
         """Set Job Statuses.
 
-        Set Job Statuses.
+        Set the status of a job or a list of jobs.
+
+        Body parameters:
+
+
+        * ``Status``\\ : The new status of the job.
+        * ``MinorStatus``\\ : The minor status of the job.
+        * ``ApplicationStatus``\\ : The application-specific status of the job.
+        * ``Source``\\ : The source of the status update (default is "Unknown").
 
         :param body: Is either a {str: {str: JobStatusUpdate}} type or a IO[bytes] type. Required.
         :type body: dict[str, dict[str, ~_generated.models.JobStatusUpdate]] or IO[bytes]
@@ -1679,14 +1703,79 @@ async def add_heartbeat(
 
         return deserialized  # type: ignore
 
+    @overload
+    async def reschedule_jobs(
+        self,
+        body: _models.BodyJobsRescheduleJobs,
+        *,
+        reset_jobs: bool = False,
+        content_type: str = "application/json",
+        **kwargs: Any
+    ) -> Dict[str, Any]:
+        """Reschedule Jobs.
+
+        Reschedule a list of killed or failed jobs.
+
+        Body parameters:
+
+
+        * ``job_ids``\\ : List of job IDs to reschedule.
+        * ``reset_jobs``\\ : If True, reset the count of reschedules for the jobs.
+
+        :param body: Required.
+        :type body: ~_generated.models.BodyJobsRescheduleJobs
+        :keyword reset_jobs: Default value is False.
+        :paramtype reset_jobs: bool
+        :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: dict mapping str to any
+        :rtype: dict[str, any]
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @overload
+    async def reschedule_jobs(
+        self, body: IO[bytes], *, reset_jobs: bool = False, content_type: str = "application/json", **kwargs: Any
+    ) -> Dict[str, Any]:
+        """Reschedule Jobs.
+
+        Reschedule a list of killed or failed jobs.
+
+        Body parameters:
+
+
+        * ``job_ids``\\ : List of job IDs to reschedule.
+        * ``reset_jobs``\\ : If True, reset the count of reschedules for the jobs.
+
+        :param body: Required.
+        :type body: IO[bytes]
+        :keyword reset_jobs: Default value is False.
+        :paramtype reset_jobs: bool
+        :keyword content_type: Body Parameter content-type. Content type parameter for binary body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: dict mapping str to any
+        :rtype: dict[str, any]
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
     @distributed_trace_async
-    async def reschedule_jobs(self, *, job_ids: List[int], reset_jobs: bool = False, **kwargs: Any) -> Dict[str, Any]:
+    async def reschedule_jobs(
+        self, body: Union[_models.BodyJobsRescheduleJobs, IO[bytes]], *, reset_jobs: bool = False, **kwargs: Any
+    ) -> Dict[str, Any]:
         """Reschedule Jobs.
 
-        Reschedule Jobs.
+        Reschedule a list of killed or failed jobs.
 
-        :keyword job_ids: Required.
-        :paramtype job_ids: list[int]
+        Body parameters:
+
+
+        * ``job_ids``\\ : List of job IDs to reschedule.
+        * ``reset_jobs``\\ : If True, reset the count of reschedules for the jobs.
+
+        :param body: Is either a BodyJobsRescheduleJobs type or a IO[bytes] type. Required.
+        :type body: ~_generated.models.BodyJobsRescheduleJobs or IO[bytes]
         :keyword reset_jobs: Default value is False.
         :paramtype reset_jobs: bool
         :return: dict mapping str to any
@@ -1701,14 +1790,25 @@ async def reschedule_jobs(self, *, job_ids: List[int], reset_jobs: bool = False,
         }
         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 {}
 
+        content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
         cls: ClsType[Dict[str, Any]] = kwargs.pop("cls", None)
 
+        content_type = content_type or "application/json"
+        _json = None
+        _content = None
+        if isinstance(body, (IOBase, bytes)):
+            _content = body
+        else:
+            _json = self._serialize.body(body, "BodyJobsRescheduleJobs")
+
         _request = build_jobs_reschedule_jobs_request(
-            job_ids=job_ids,
             reset_jobs=reset_jobs,
+            content_type=content_type,
+            json=_json,
+            content=_content,
             headers=_headers,
             params=_params,
         )
@@ -1734,14 +1834,15 @@ async def reschedule_jobs(self, *, job_ids: List[int], reset_jobs: bool = False,
 
     @overload
     async def patch_metadata(
-        self, body: Dict[str, Dict[str, Any]], *, content_type: str = "application/json", **kwargs: Any
+        self, body: Dict[str, _models.JobMetaData], *, content_type: str = "application/json", **kwargs: Any
     ) -> None:
         """Patch Metadata.
 
-        Patch Metadata.
+        Update job metadata such as UserPriority, HeartBeatTime, JobType, etc.
+        The argument  are all the attributes/parameters of a job (except the ID).
 
         :param body: Required.
-        :type body: dict[str, dict[str, any]]
+        :type body: dict[str, ~_generated.models.JobMetaData]
         :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
          Default value is "application/json".
         :paramtype content_type: str
@@ -1754,7 +1855,8 @@ async def patch_metadata(
     async def patch_metadata(self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any) -> None:
         """Patch Metadata.
 
-        Patch Metadata.
+        Update job metadata such as UserPriority, HeartBeatTime, JobType, etc.
+        The argument  are all the attributes/parameters of a job (except the ID).
 
         :param body: Required.
         :type body: IO[bytes]
@@ -1767,13 +1869,14 @@ async def patch_metadata(self, body: IO[bytes], *, content_type: str = "applicat
         """
 
     @distributed_trace_async
-    async def patch_metadata(self, body: Union[Dict[str, Dict[str, Any]], IO[bytes]], **kwargs: Any) -> None:
+    async def patch_metadata(self, body: Union[Dict[str, _models.JobMetaData], IO[bytes]], **kwargs: Any) -> None:
         """Patch Metadata.
 
-        Patch Metadata.
+        Update job metadata such as UserPriority, HeartBeatTime, JobType, etc.
+        The argument  are all the attributes/parameters of a job (except the ID).
 
-        :param body: Is either a {str: {str: Any}} type or a IO[bytes] type. Required.
-        :type body: dict[str, dict[str, any]] or IO[bytes]
+        :param body: Is either a {str: JobMetaData} type or a IO[bytes] type. Required.
+        :type body: dict[str, ~_generated.models.JobMetaData] or IO[bytes]
         :return: None
         :rtype: None
         :raises ~azure.core.exceptions.HttpResponseError:
@@ -1798,7 +1901,7 @@ async def patch_metadata(self, body: Union[Dict[str, Dict[str, Any]], IO[bytes]]
         if isinstance(body, (IOBase, bytes)):
             _content = body
         else:
-            _json = self._serialize.body(body, "{{object}}")
+            _json = self._serialize.body(body, "{JobMetaData}")
 
         _request = build_jobs_patch_metadata_request(
             content_type=content_type,
@@ -1835,9 +1938,18 @@ async def search(
     ) -> List[Dict[str, Any]]:
         """Search.
 
-        Retrieve information about jobs.
+        Creates a search query to the job database. This search can be based on
+        different parameters, such as job ID, status, owner, etc.
+
+        **Possibilities**
+
 
-        **TODO: Add more docs**.
+        * Use ``search`` to filter jobs based on various parameters (optional).
+        * Use ``parameters`` to specify which job parameters to return (optional).
+        * Use ``sort`` to order the results based on specific parameters (optional).
+
+        By default, the search will return all jobs the user has access to, and all the fields
+        of the job will be returned.
 
         :param body: Default value is None.
         :type body: ~_generated.models.JobSearchParams
@@ -1865,9 +1977,18 @@ async def search(
     ) -> List[Dict[str, Any]]:
         """Search.
 
-        Retrieve information about jobs.
+        Creates a search query to the job database. This search can be based on
+        different parameters, such as job ID, status, owner, etc.
+
+        **Possibilities**
+
 
-        **TODO: Add more docs**.
+        * Use ``search`` to filter jobs based on various parameters (optional).
+        * Use ``parameters`` to specify which job parameters to return (optional).
+        * Use ``sort`` to order the results based on specific parameters (optional).
+
+        By default, the search will return all jobs the user has access to, and all the fields
+        of the job will be returned.
 
         :param body: Default value is None.
         :type body: IO[bytes]
@@ -1894,9 +2015,18 @@ async def search(
     ) -> List[Dict[str, Any]]:
         """Search.
 
-        Retrieve information about jobs.
+        Creates a search query to the job database. This search can be based on
+        different parameters, such as job ID, status, owner, etc.
+
+        **Possibilities**
 
-        **TODO: Add more docs**.
+
+        * Use ``search`` to filter jobs based on various parameters (optional).
+        * Use ``parameters`` to specify which job parameters to return (optional).
+        * Use ``sort`` to order the results based on specific parameters (optional).
+
+        By default, the search will return all jobs the user has access to, and all the fields
+        of the job will be returned.
 
         :param body: Is either a JobSearchParams type or a IO[bytes] type. Default value is None.
         :type body: ~_generated.models.JobSearchParams or IO[bytes]
@@ -1972,7 +2102,15 @@ async def summary(
     ) -> Any:
         """Summary.
 
-        Show information suitable for plotting.
+        Group jobs by a specific list of parameters. Returns an array of n-uplets, where each n-uplet
+        contains the
+        values of the grouping parameters and the number of jobs that match those values.
+
+        Body parameters:
+
+
+        * ``grouping``\\ : List of parameters to group the jobs by.
+        * ``search``\\ : List of search parameters to filter the jobs by (optional).
 
         :param body: Required.
         :type body: ~_generated.models.JobSummaryParams
@@ -1988,7 +2126,15 @@ async def summary(
     async def summary(self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any) -> Any:
         """Summary.
 
-        Show information suitable for plotting.
+        Group jobs by a specific list of parameters. Returns an array of n-uplets, where each n-uplet
+        contains the
+        values of the grouping parameters and the number of jobs that match those values.
+
+        Body parameters:
+
+
+        * ``grouping``\\ : List of parameters to group the jobs by.
+        * ``search``\\ : List of search parameters to filter the jobs by (optional).
 
         :param body: Required.
         :type body: IO[bytes]
@@ -2004,7 +2150,15 @@ async def summary(self, body: IO[bytes], *, content_type: str = "application/jso
     async def summary(self, body: Union[_models.JobSummaryParams, IO[bytes]], **kwargs: Any) -> Any:
         """Summary.
 
-        Show information suitable for plotting.
+        Group jobs by a specific list of parameters. Returns an array of n-uplets, where each n-uplet
+        contains the
+        values of the grouping parameters and the number of jobs that match those values.
+
+        Body parameters:
+
+
+        * ``grouping``\\ : List of parameters to group the jobs by.
+        * ``search``\\ : List of search parameters to filter the jobs by (optional).
 
         :param body: Is either a JobSummaryParams type or a IO[bytes] type. Required.
         :type body: ~_generated.models.JobSummaryParams or IO[bytes]

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

@@ -14,12 +14,15 @@
 from ._models import (  # type: ignore
     BodyAuthGetOidcToken,
     BodyAuthGetOidcTokenGrantType,
+    BodyJobsRescheduleJobs,
     GroupInfo,
     HTTPValidationError,
     HeartbeatData,
     InitiateDeviceFlowResponse,
     InsertedJob,
     JobCommand,
+    JobMetaData,
+    JobMetaDataAccountedFlag,
     JobSearchParams,
     JobSearchParamsSearchItem,
     JobStatusUpdate,
@@ -61,12 +64,15 @@
 __all__ = [
     "BodyAuthGetOidcToken",
     "BodyAuthGetOidcTokenGrantType",
+    "BodyJobsRescheduleJobs",
     "GroupInfo",
     "HTTPValidationError",
     "HeartbeatData",
     "InitiateDeviceFlowResponse",
     "InsertedJob",
     "JobCommand",
+    "JobMetaData",
+    "JobMetaDataAccountedFlag",
     "JobSearchParams",
     "JobSearchParamsSearchItem",
     "JobStatusUpdate",