Skip to content

Commit d9617e7

Browse files
fix async job path op
1 parent 3a7560b commit d9617e7

File tree

4 files changed

+49
-49
lines changed

4 files changed

+49
-49
lines changed

api/specs/web-server/_long_running_tasks.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@
3131
"/tasks",
3232
response_model=Envelope[list[TaskGet]],
3333
)
34-
def list_tasks():
34+
def get_async_jobs():
3535
"""Lists all long running tasks"""
3636

3737

3838
@router.get(
3939
"/tasks/{task_id}",
4040
response_model=Envelope[TaskStatus],
4141
)
42-
def get_task_status(
42+
def get_async_job_status(
4343
_path_params: Annotated[_PathParam, Depends()],
4444
):
4545
"""Retrieves the status of a task"""
@@ -48,7 +48,7 @@ def get_task_status(
4848
@router.get(
4949
"/tasks/{task_id}/stream",
5050
)
51-
def get_task_stream(
51+
def get_async_job_stream(
5252
_path_params: Annotated[_PathParam, Depends()],
5353
):
5454
"""Retrieves the stream of a task"""
@@ -58,7 +58,7 @@ def get_task_stream(
5858
"/tasks/{task_id}",
5959
status_code=status.HTTP_204_NO_CONTENT,
6060
)
61-
def cancel_task(
61+
def cancel_async_job(
6262
_path_params: Annotated[_PathParam, Depends()],
6363
):
6464
"""Cancels and removes a task"""
@@ -68,7 +68,7 @@ def cancel_task(
6868
"/tasks/{task_id}/result",
6969
response_model=Any,
7070
)
71-
def get_task_result(
71+
def get_async_job_result(
7272
_path_params: Annotated[_PathParam, Depends()],
7373
):
7474
"""Retrieves the result of a task"""

api/specs/web-server/_long_running_tasks_legacy.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,40 +23,40 @@
2323
@router.get(
2424
"",
2525
response_model=Envelope[list[TaskGet]],
26-
name="list_tasks_legacy",
27-
description="Lists all long running tasks (legacy)",
26+
name="list_tasks",
27+
description="Lists all long running tasks",
2828
)
29-
async def list_tasks_legacy(): ...
29+
async def list_tasks(): ...
3030

3131

3232
@router.get(
3333
"/{task_id}",
3434
response_model=Envelope[TaskStatus],
35-
name="get_task_status_legacy",
36-
description="Retrieves the status of a task (legacy)",
35+
name="get_task_status",
36+
description="Retrieves the status of a task",
3737
)
38-
async def get_task_status_legacy(
38+
async def get_task_status(
3939
_path_params: Annotated[_PathParam, Depends()],
4040
): ...
4141

4242

4343
@router.delete(
4444
"/{task_id}",
45-
name="remove_task_legacy",
46-
description="Cancels and removes a task (legacy)",
45+
name="remove_task",
46+
description="Cancels and removes a task",
4747
status_code=status.HTTP_204_NO_CONTENT,
4848
)
49-
async def remove_task_legacy(
49+
async def remove_task(
5050
_path_params: Annotated[_PathParam, Depends()],
5151
): ...
5252

5353

5454
@router.get(
5555
"/{task_id}/result",
56-
name="get_task_result_legacy",
56+
name="get_task_result",
5757
response_model=Any,
58-
description="Retrieves the result of a task (legacy)",
58+
description="Retrieves the result of a task",
5959
)
60-
async def get_task_result_legacy(
60+
async def get_task_result(
6161
_path_params: Annotated[_PathParam, Depends()],
6262
): ...

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3882,9 +3882,9 @@ paths:
38823882
get:
38833883
tags:
38843884
- long-running-tasks
3885-
summary: List Tasks
3885+
summary: Get Async Jobs
38863886
description: Lists all long running tasks
3887-
operationId: list_tasks
3887+
operationId: get_async_jobs
38883888
responses:
38893889
'200':
38903890
description: Successful Response
@@ -3920,9 +3920,9 @@ paths:
39203920
get:
39213921
tags:
39223922
- long-running-tasks
3923-
summary: Get Task Status
3923+
summary: Get Async Job Status
39243924
description: Retrieves the status of a task
3925-
operationId: get_task_status
3925+
operationId: get_async_job_status
39263926
parameters:
39273927
- name: task_id
39283928
in: path
@@ -3964,9 +3964,9 @@ paths:
39643964
delete:
39653965
tags:
39663966
- long-running-tasks
3967-
summary: Cancel Task
3967+
summary: Cancel Async Job
39683968
description: Cancels and removes a task
3969-
operationId: cancel_task
3969+
operationId: cancel_async_job
39703970
parameters:
39713971
- name: task_id
39723972
in: path
@@ -4005,9 +4005,9 @@ paths:
40054005
get:
40064006
tags:
40074007
- long-running-tasks
4008-
summary: Get Task Stream
4008+
summary: Get Async Job Stream
40094009
description: Retrieves the stream of a task
4010-
operationId: get_task_stream
4010+
operationId: get_async_job_stream
40114011
parameters:
40124012
- name: task_id
40134013
in: path
@@ -4049,9 +4049,9 @@ paths:
40494049
get:
40504050
tags:
40514051
- long-running-tasks
4052-
summary: Get Task Result
4052+
summary: Get Async Job Result
40534053
description: Retrieves the result of a task
4054-
operationId: get_task_result
4054+
operationId: get_async_job_result
40554055
parameters:
40564056
- name: task_id
40574057
in: path
@@ -4065,7 +4065,7 @@ paths:
40654065
content:
40664066
application/json:
40674067
schema:
4068-
title: Response Get Task Result
4068+
title: Response Get Async Job Result
40694069
'404':
40704070
content:
40714071
application/json:
@@ -4094,9 +4094,9 @@ paths:
40944094
get:
40954095
tags:
40964096
- long-running-tasks-legacy
4097-
summary: List Tasks Legacy
4098-
description: Lists all long running tasks (legacy)
4099-
operationId: list_tasks_legacy
4097+
summary: List Tasks
4098+
description: Lists all long running tasks
4099+
operationId: list_tasks
41004100
responses:
41014101
'200':
41024102
description: Successful Response
@@ -4108,9 +4108,9 @@ paths:
41084108
get:
41094109
tags:
41104110
- long-running-tasks-legacy
4111-
summary: Get Task Status Legacy
4112-
description: Retrieves the status of a task (legacy)
4113-
operationId: get_task_status_legacy
4111+
summary: Get Task Status
4112+
description: Retrieves the status of a task
4113+
operationId: get_task_status
41144114
parameters:
41154115
- name: task_id
41164116
in: path
@@ -4128,9 +4128,9 @@ paths:
41284128
delete:
41294129
tags:
41304130
- long-running-tasks-legacy
4131-
summary: Remove Task Legacy
4132-
description: Cancels and removes a task (legacy)
4133-
operationId: remove_task_legacy
4131+
summary: Remove Task
4132+
description: Cancels and removes a task
4133+
operationId: remove_task
41344134
parameters:
41354135
- name: task_id
41364136
in: path
@@ -4145,9 +4145,9 @@ paths:
41454145
get:
41464146
tags:
41474147
- long-running-tasks-legacy
4148-
summary: Get Task Result Legacy
4149-
description: Retrieves the result of a task (legacy)
4150-
operationId: get_task_result_legacy
4148+
summary: Get Task Result
4149+
description: Retrieves the result of a task
4150+
operationId: get_task_result
41514151
parameters:
41524152
- name: task_id
41534153
in: path
@@ -4161,7 +4161,7 @@ paths:
41614161
content:
41624162
application/json:
41634163
schema:
4164-
title: Response Get Task Result Legacy
4164+
title: Response Get Task Result
41654165
/v0/catalog/licensed-items:
41664166
get:
41674167
tags:

services/web/server/src/simcore_service_webserver/tasks/_controller/_rest.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@
3838

3939
@routes.get(
4040
_task_prefix,
41-
name="get_tasks",
41+
name="get_async_jobs",
4242
)
4343
@login_required
4444
@handle_rest_requests_exceptions
4545
@webserver_request_context_decorator
46-
async def get_tasks(request: web.Request) -> web.Response:
46+
async def get_async_jobs(request: web.Request) -> web.Response:
4747
inprocess_long_running_manager = get_long_running_manager(request.app)
4848
inprocess_tracked_tasks = await lrt_api.list_tasks(
4949
inprocess_long_running_manager.rpc_client,
@@ -89,11 +89,11 @@ async def get_tasks(request: web.Request) -> web.Response:
8989

9090
@routes.get(
9191
_task_prefix + "/{task_id}",
92-
name="get_task_status",
92+
name="get_async_job_status",
9393
)
9494
@login_required
9595
@handle_rest_requests_exceptions
96-
async def get_task_status(request: web.Request) -> web.Response:
96+
async def get_async_job_status(request: web.Request) -> web.Response:
9797

9898
_req_ctx = AuthenticatedRequestContext.model_validate(request)
9999
_path_params = parse_request_path_parameters_as(TaskPathParams, request)
@@ -124,11 +124,11 @@ async def get_task_status(request: web.Request) -> web.Response:
124124

125125
@routes.delete(
126126
_task_prefix + "/{task_id}",
127-
name="cancel_task",
127+
name="cancel_async_job",
128128
)
129129
@login_required
130130
@handle_rest_requests_exceptions
131-
async def cancel_task(request: web.Request) -> web.Response:
131+
async def cancel_async_job(request: web.Request) -> web.Response:
132132

133133
_req_ctx = AuthenticatedRequestContext.model_validate(request)
134134
_path_params = parse_request_path_parameters_as(TaskPathParams, request)
@@ -149,11 +149,11 @@ async def cancel_task(request: web.Request) -> web.Response:
149149

150150
@routes.get(
151151
_task_prefix + "/{task_id}/result",
152-
name="get_task_result",
152+
name="get_async_job_result",
153153
)
154154
@login_required
155155
@handle_rest_requests_exceptions
156-
async def get_task_result(request: web.Request) -> web.Response:
156+
async def get_async_job_result(request: web.Request) -> web.Response:
157157

158158
_req_ctx = AuthenticatedRequestContext.model_validate(request)
159159
_path_params = parse_request_path_parameters_as(TaskPathParams, request)

0 commit comments

Comments
 (0)