chore(serverless_jobs): rename id to job_definition_id and id to job_run_id (#381)

Author: scaleway-bot

scaleway-async/scaleway_async/jobs/v1alpha1/api.py

@@ -125,25 +125,27 @@ async def create_job_definition(
     async def get_job_definition(
         self,
         *,
-        id: str,
+        job_definition_id: str,
         region: Optional[Region] = None,
     ) -> JobDefinition:
         """
 
         Usage:
         ::
 
-            result = await api.get_job_definition(id="example")
+            result = await api.get_job_definition(job_definition_id="example")
         """
 
         param_region = validate_path_param(
             "region", region or self.client.default_region
         )
-        param_id = validate_path_param("id", id)
+        param_job_definition_id = validate_path_param(
+            "job_definition_id", job_definition_id
+        )
 
         res = self._request(
             "GET",
-            f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_id}",
+            f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_job_definition_id}",
         )
 
         self._throw_on_error(res)
@@ -218,7 +220,7 @@ async def list_job_definitions_all(
     async def update_job_definition(
         self,
         *,
-        id: str,
+        job_definition_id: str,
         region: Optional[Region] = None,
         name: Optional[str] = None,
         cpu_limit: Optional[int] = None,
@@ -234,20 +236,22 @@ async def update_job_definition(
         Usage:
         ::
 
-            result = await api.update_job_definition(id="example")
+            result = await api.update_job_definition(job_definition_id="example")
         """
 
         param_region = validate_path_param(
             "region", region or self.client.default_region
         )
-        param_id = validate_path_param("id", id)
+        param_job_definition_id = validate_path_param(
+            "job_definition_id", job_definition_id
+        )
 
         res = self._request(
             "PATCH",
-            f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_id}",
+            f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_job_definition_id}",
             body=marshal_UpdateJobDefinitionRequest(
                 UpdateJobDefinitionRequest(
-                    id=id,
+                    job_definition_id=job_definition_id,
                     region=region,
                     name=name,
                     cpu_limit=cpu_limit,
@@ -268,25 +272,27 @@ async def update_job_definition(
     async def delete_job_definition(
         self,
         *,
-        id: str,
+        job_definition_id: str,
         region: Optional[Region] = None,
     ) -> Optional[None]:
         """
 
         Usage:
         ::
 
-            result = await api.delete_job_definition(id="example")
+            result = await api.delete_job_definition(job_definition_id="example")
         """
 
         param_region = validate_path_param(
             "region", region or self.client.default_region
         )
-        param_id = validate_path_param("id", id)
+        param_job_definition_id = validate_path_param(
+            "job_definition_id", job_definition_id
+        )
 
         res = self._request(
             "DELETE",
-            f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_id}",
+            f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_job_definition_id}",
         )
 
         self._throw_on_error(res)
@@ -295,25 +301,27 @@ async def delete_job_definition(
     async def start_job_definition(
         self,
         *,
-        id: str,
+        job_definition_id: str,
         region: Optional[Region] = None,
     ) -> JobRun:
         """
 
         Usage:
         ::
 
-            result = await api.start_job_definition(id="example")
+            result = await api.start_job_definition(job_definition_id="example")
         """
 
         param_region = validate_path_param(
             "region", region or self.client.default_region
         )
-        param_id = validate_path_param("id", id)
+        param_job_definition_id = validate_path_param(
+            "job_definition_id", job_definition_id
+        )
 
         res = self._request(
             "POST",
-            f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_id}/start",
+            f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_job_definition_id}/start",
         )
 
         self._throw_on_error(res)
@@ -322,25 +330,25 @@ async def start_job_definition(
     async def get_job_run(
         self,
         *,
-        id: str,
+        job_run_id: str,
         region: Optional[Region] = None,
     ) -> JobRun:
         """
 
         Usage:
         ::
 
-            result = await api.get_job_run(id="example")
+            result = await api.get_job_run(job_run_id="example")
         """
 
         param_region = validate_path_param(
             "region", region or self.client.default_region
         )
-        param_id = validate_path_param("id", id)
+        param_job_run_id = validate_path_param("job_run_id", job_run_id)
 
         res = self._request(
             "GET",
-            f"/serverless-jobs/v1alpha1/regions/{param_region}/job-runs/{param_id}",
+            f"/serverless-jobs/v1alpha1/regions/{param_region}/job-runs/{param_job_run_id}",
         )
 
         self._throw_on_error(res)
@@ -349,25 +357,25 @@ async def get_job_run(
     async def stop_job_run(
         self,
         *,
-        id: str,
+        job_run_id: str,
         region: Optional[Region] = None,
     ) -> JobRun:
         """
 
         Usage:
         ::
 
-            result = await api.stop_job_run(id="example")
+            result = await api.stop_job_run(job_run_id="example")
         """
 
         param_region = validate_path_param(
             "region", region or self.client.default_region
         )
-        param_id = validate_path_param("id", id)
+        param_job_run_id = validate_path_param("job_run_id", job_run_id)
 
         res = self._request(
             "POST",
-            f"/serverless-jobs/v1alpha1/regions/{param_region}/job-runs/{param_id}/stop",
+            f"/serverless-jobs/v1alpha1/regions/{param_region}/job-runs/{param_job_run_id}/stop",
         )
 
         self._throw_on_error(res)
@@ -380,7 +388,7 @@ async def list_job_runs(
         page: Optional[int] = None,
         page_size: Optional[int] = None,
         order_by: ListJobRunsRequestOrderBy = ListJobRunsRequestOrderBy.CREATED_AT_ASC,
-        id: Optional[str] = None,
+        job_definition_id: Optional[str] = None,
         project_id: Optional[str] = None,
     ) -> ListJobRunsResponse:
         """
@@ -399,7 +407,7 @@ async def list_job_runs(
             "GET",
             f"/serverless-jobs/v1alpha1/regions/{param_region}/job-runs",
             params={
-                "id": id,
+                "job_definition_id": job_definition_id,
                 "order_by": order_by,
                 "page": page,
                 "page_size": page_size or self.client.default_page_size,
@@ -417,7 +425,7 @@ async def list_job_runs_all(
         page: Optional[int] = None,
         page_size: Optional[int] = None,
         order_by: Optional[ListJobRunsRequestOrderBy] = None,
-        id: Optional[str] = None,
+        job_definition_id: Optional[str] = None,
         project_id: Optional[str] = None,
     ) -> List[JobRun]:
         """
@@ -438,7 +446,7 @@ async def list_job_runs_all(
                 "page": page,
                 "page_size": page_size,
                 "order_by": order_by,
-                "id": id,
+                "job_definition_id": job_definition_id,
                 "project_id": project_id,
             },
         )

scaleway-async/scaleway_async/jobs/v1alpha1/types.py

@@ -151,7 +151,7 @@ class GetJobDefinitionRequest:
     Region to target. If none is passed will use default region from the config.
     """
 
-    id: str
+    job_definition_id: str
 
 
 @dataclass
@@ -177,7 +177,7 @@ class UpdateJobDefinitionRequest:
     Region to target. If none is passed will use default region from the config.
     """
 
-    id: str
+    job_definition_id: str
 
     name: Optional[str]
 
@@ -203,7 +203,7 @@ class DeleteJobDefinitionRequest:
     Region to target. If none is passed will use default region from the config.
     """
 
-    id: str
+    job_definition_id: str
 
 
 @dataclass
@@ -213,7 +213,7 @@ class StartJobDefinitionRequest:
     Region to target. If none is passed will use default region from the config.
     """
 
-    id: str
+    job_definition_id: str
 
 
 @dataclass
@@ -223,7 +223,7 @@ class GetJobRunRequest:
     Region to target. If none is passed will use default region from the config.
     """
 
-    id: str
+    job_run_id: str
 
 
 @dataclass
@@ -233,7 +233,7 @@ class StopJobRunRequest:
     Region to target. If none is passed will use default region from the config.
     """
 
-    id: str
+    job_run_id: str
 
 
 @dataclass
@@ -249,6 +249,6 @@ class ListJobRunsRequest:
 
     order_by: Optional[ListJobRunsRequestOrderBy]
 
-    id: Optional[str]
+    job_definition_id: Optional[str]
 
     project_id: Optional[str]