Skip to content

Commit 9e05a7a

Browse files
committed
update openapi specs
1 parent c8c46ee commit 9e05a7a

File tree

2 files changed

+112
-224
lines changed

2 files changed

+112
-224
lines changed

api/specs/web-server/_long_running_tasks.py

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@
3232
@router.get(
3333
"/tasks",
3434
response_model=Envelope[list[TaskGet]],
35-
name="get_async_jobs",
35+
name="list_tasks",
36+
description="Lists all long running tasks",
3637
responses=_data_export_responses,
3738
)
3839
def list_tasks(): ...
@@ -41,7 +42,8 @@ def list_tasks(): ...
4142
@router.get(
4243
"/tasks/{task_id}",
4344
response_model=Envelope[TaskStatus],
44-
name="get_async_job_status",
45+
name="get_task_status",
46+
description="Retrieves the status of a task",
4547
responses=_data_export_responses,
4648
)
4749
def get_task_status(
@@ -51,7 +53,8 @@ def get_task_status(
5153

5254
@router.delete(
5355
"/tasks/{task_id}",
54-
name="abort_async_job",
56+
name="cancel_and_delete_task",
57+
description="Cancels and deletes a task",
5558
responses=_data_export_responses,
5659
status_code=status.HTTP_204_NO_CONTENT,
5760
)
@@ -60,9 +63,12 @@ def cancel_and_delete_task(
6063
): ...
6164

6265

63-
@router.get("/tasks/{task_id}/result")
66+
@router.get(
67+
"/tasks/{task_id}/result",
68+
name="get_task_result",
69+
description="Retrieves the result of a task",
70+
responses=_data_export_responses,
71+
)
6472
def get_task_result(
6573
_path_params: Annotated[_PathParam, Depends()],
66-
name="get_async_job_result",
67-
responses=_data_export_responses,
6874
): ...

0 commit comments

Comments
 (0)