Skip to content

Commit ad72f47

Browse files
scaleway-botscaleway-bot
authored
chore(serverless): rename job_run_id to id and job_definition_id to id (scaleway#360)
1 parent bd863b6 commit ad72f47

File tree

6 files changed

+88
-104
lines changed

6 files changed

+88
-104
lines changed

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

Lines changed: 29 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -125,27 +125,25 @@ async def create_job_definition(
125125
async def get_job_definition(
126126
self,
127127
*,
128-
job_definition_id: str,
128+
id: str,
129129
region: Optional[Region] = None,
130130
) -> JobDefinition:
131131
"""
132132
133133
Usage:
134134
::
135135
136-
result = await api.get_job_definition(job_definition_id="example")
136+
result = await api.get_job_definition(id="example")
137137
"""
138138

139139
param_region = validate_path_param(
140140
"region", region or self.client.default_region
141141
)
142-
param_job_definition_id = validate_path_param(
143-
"job_definition_id", job_definition_id
144-
)
142+
param_id = validate_path_param("id", id)
145143

146144
res = self._request(
147145
"GET",
148-
f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_job_definition_id}",
146+
f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_id}",
149147
)
150148

151149
self._throw_on_error(res)
@@ -220,7 +218,7 @@ async def list_job_definitions_all(
220218
async def update_job_definition(
221219
self,
222220
*,
223-
job_definition_id: str,
221+
id: str,
224222
region: Optional[Region] = None,
225223
name: Optional[str] = None,
226224
cpu_limit: Optional[int] = None,
@@ -236,22 +234,20 @@ async def update_job_definition(
236234
Usage:
237235
::
238236
239-
result = await api.update_job_definition(job_definition_id="example")
237+
result = await api.update_job_definition(id="example")
240238
"""
241239

242240
param_region = validate_path_param(
243241
"region", region or self.client.default_region
244242
)
245-
param_job_definition_id = validate_path_param(
246-
"job_definition_id", job_definition_id
247-
)
243+
param_id = validate_path_param("id", id)
248244

249245
res = self._request(
250246
"PATCH",
251-
f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_job_definition_id}",
247+
f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_id}",
252248
body=marshal_UpdateJobDefinitionRequest(
253249
UpdateJobDefinitionRequest(
254-
job_definition_id=job_definition_id,
250+
id=id,
255251
region=region,
256252
name=name,
257253
cpu_limit=cpu_limit,
@@ -272,27 +268,25 @@ async def update_job_definition(
272268
async def delete_job_definition(
273269
self,
274270
*,
275-
job_definition_id: str,
271+
id: str,
276272
region: Optional[Region] = None,
277273
) -> Optional[None]:
278274
"""
279275
280276
Usage:
281277
::
282278
283-
result = await api.delete_job_definition(job_definition_id="example")
279+
result = await api.delete_job_definition(id="example")
284280
"""
285281

286282
param_region = validate_path_param(
287283
"region", region or self.client.default_region
288284
)
289-
param_job_definition_id = validate_path_param(
290-
"job_definition_id", job_definition_id
291-
)
285+
param_id = validate_path_param("id", id)
292286

293287
res = self._request(
294288
"DELETE",
295-
f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_job_definition_id}",
289+
f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_id}",
296290
)
297291

298292
self._throw_on_error(res)
@@ -301,27 +295,25 @@ async def delete_job_definition(
301295
async def start_job_definition(
302296
self,
303297
*,
304-
job_definition_id: str,
298+
id: str,
305299
region: Optional[Region] = None,
306300
) -> JobRun:
307301
"""
308302
309303
Usage:
310304
::
311305
312-
result = await api.start_job_definition(job_definition_id="example")
306+
result = await api.start_job_definition(id="example")
313307
"""
314308

315309
param_region = validate_path_param(
316310
"region", region or self.client.default_region
317311
)
318-
param_job_definition_id = validate_path_param(
319-
"job_definition_id", job_definition_id
320-
)
312+
param_id = validate_path_param("id", id)
321313

322314
res = self._request(
323315
"POST",
324-
f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_job_definition_id}/start",
316+
f"/serverless-jobs/v1alpha1/regions/{param_region}/job-definitions/{param_id}/start",
325317
)
326318

327319
self._throw_on_error(res)
@@ -330,25 +322,25 @@ async def start_job_definition(
330322
async def get_job_run(
331323
self,
332324
*,
333-
job_run_id: str,
325+
id: str,
334326
region: Optional[Region] = None,
335327
) -> JobRun:
336328
"""
337329
338330
Usage:
339331
::
340332
341-
result = await api.get_job_run(job_run_id="example")
333+
result = await api.get_job_run(id="example")
342334
"""
343335

344336
param_region = validate_path_param(
345337
"region", region or self.client.default_region
346338
)
347-
param_job_run_id = validate_path_param("job_run_id", job_run_id)
339+
param_id = validate_path_param("id", id)
348340

349341
res = self._request(
350342
"GET",
351-
f"/serverless-jobs/v1alpha1/regions/{param_region}/job-runs/{param_job_run_id}",
343+
f"/serverless-jobs/v1alpha1/regions/{param_region}/job-runs/{param_id}",
352344
)
353345

354346
self._throw_on_error(res)
@@ -357,25 +349,25 @@ async def get_job_run(
357349
async def stop_job_run(
358350
self,
359351
*,
360-
job_run_id: str,
352+
id: str,
361353
region: Optional[Region] = None,
362354
) -> JobRun:
363355
"""
364356
365357
Usage:
366358
::
367359
368-
result = await api.stop_job_run(job_run_id="example")
360+
result = await api.stop_job_run(id="example")
369361
"""
370362

371363
param_region = validate_path_param(
372364
"region", region or self.client.default_region
373365
)
374-
param_job_run_id = validate_path_param("job_run_id", job_run_id)
366+
param_id = validate_path_param("id", id)
375367

376368
res = self._request(
377369
"POST",
378-
f"/serverless-jobs/v1alpha1/regions/{param_region}/job-runs/{param_job_run_id}/stop",
370+
f"/serverless-jobs/v1alpha1/regions/{param_region}/job-runs/{param_id}/stop",
379371
)
380372

381373
self._throw_on_error(res)
@@ -388,7 +380,7 @@ async def list_job_runs(
388380
page: Optional[int] = None,
389381
page_size: Optional[int] = None,
390382
order_by: ListJobRunsRequestOrderBy = ListJobRunsRequestOrderBy.CREATED_AT_ASC,
391-
job_definition_id: Optional[str] = None,
383+
id: Optional[str] = None,
392384
project_id: Optional[str] = None,
393385
) -> ListJobRunsResponse:
394386
"""
@@ -407,7 +399,7 @@ async def list_job_runs(
407399
"GET",
408400
f"/serverless-jobs/v1alpha1/regions/{param_region}/job-runs",
409401
params={
410-
"job_definition_id": job_definition_id,
402+
"id": id,
411403
"order_by": order_by,
412404
"page": page,
413405
"page_size": page_size or self.client.default_page_size,
@@ -425,7 +417,7 @@ async def list_job_runs_all(
425417
page: Optional[int] = None,
426418
page_size: Optional[int] = None,
427419
order_by: Optional[ListJobRunsRequestOrderBy] = None,
428-
job_definition_id: Optional[str] = None,
420+
id: Optional[str] = None,
429421
project_id: Optional[str] = None,
430422
) -> List[JobRun]:
431423
"""
@@ -446,7 +438,7 @@ async def list_job_runs_all(
446438
"page": page,
447439
"page_size": page_size,
448440
"order_by": order_by,
449-
"job_definition_id": job_definition_id,
441+
"id": id,
450442
"project_id": project_id,
451443
},
452444
)

‎scaleway-async/scaleway_async/jobs/v1alpha1/marshalling.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ def unmarshal_JobDefinition(data: Any) -> JobDefinition:
3838
field = data.get("environment_variables", None)
3939
args["environment_variables"] = field
4040

41+
field = data.get("id", None)
42+
args["id"] = field
43+
4144
field = data.get("image_uri", None)
4245
args["image_uri"] = field
4346

44-
field = data.get("job_definition_id", None)
45-
args["job_definition_id"] = field
46-
4747
field = data.get("job_timeout", None)
4848
args["job_timeout"] = field
4949

@@ -82,12 +82,12 @@ def unmarshal_JobRun(data: Any) -> JobRun:
8282
field = data.get("exit_code", None)
8383
args["exit_code"] = field
8484

85+
field = data.get("id", None)
86+
args["id"] = field
87+
8588
field = data.get("job_definition_id", None)
8689
args["job_definition_id"] = field
8790

88-
field = data.get("job_run_id", None)
89-
args["job_run_id"] = field
90-
9191
field = data.get("region", None)
9292
args["region"] = field
9393

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ def __str__(self) -> str:
4646

4747
@dataclass
4848
class JobDefinition:
49-
job_definition_id: str
49+
id: str
5050

5151
name: str
5252

@@ -75,7 +75,7 @@ class JobDefinition:
7575

7676
@dataclass
7777
class JobRun:
78-
job_run_id: str
78+
id: str
7979

8080
job_definition_id: str
8181

@@ -151,7 +151,7 @@ class GetJobDefinitionRequest:
151151
Region to target. If none is passed will use default region from the config.
152152
"""
153153

154-
job_definition_id: str
154+
id: str
155155

156156

157157
@dataclass
@@ -177,7 +177,7 @@ class UpdateJobDefinitionRequest:
177177
Region to target. If none is passed will use default region from the config.
178178
"""
179179

180-
job_definition_id: str
180+
id: str
181181

182182
name: Optional[str]
183183

@@ -203,7 +203,7 @@ class DeleteJobDefinitionRequest:
203203
Region to target. If none is passed will use default region from the config.
204204
"""
205205

206-
job_definition_id: str
206+
id: str
207207

208208

209209
@dataclass
@@ -213,7 +213,7 @@ class StartJobDefinitionRequest:
213213
Region to target. If none is passed will use default region from the config.
214214
"""
215215

216-
job_definition_id: str
216+
id: str
217217

218218

219219
@dataclass
@@ -223,7 +223,7 @@ class GetJobRunRequest:
223223
Region to target. If none is passed will use default region from the config.
224224
"""
225225

226-
job_run_id: str
226+
id: str
227227

228228

229229
@dataclass
@@ -233,7 +233,7 @@ class StopJobRunRequest:
233233
Region to target. If none is passed will use default region from the config.
234234
"""
235235

236-
job_run_id: str
236+
id: str
237237

238238

239239
@dataclass
@@ -249,6 +249,6 @@ class ListJobRunsRequest:
249249

250250
order_by: Optional[ListJobRunsRequestOrderBy]
251251

252-
job_definition_id: Optional[str]
252+
id: Optional[str]
253253

254254
project_id: Optional[str]

0 commit comments

Comments
 (0)