Skip to content

Commit 3a7560b

Browse files
fix openapi-spec
1 parent abd4bd4 commit 3a7560b

File tree

2 files changed

+78
-34
lines changed

2 files changed

+78
-34
lines changed

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_legacy_tasks",
27-
description="Lists all long running tasks",
26+
name="list_tasks_legacy",
27+
description="Lists all long running tasks (legacy)",
2828
)
29-
async def list_legacy_tasks(): ...
29+
async def list_tasks_legacy(): ...
3030

3131

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

4242

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

5353

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

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

Lines changed: 66 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3882,9 +3882,9 @@ paths:
38823882
get:
38833883
tags:
38843884
- long-running-tasks
3885-
summary: Get Async Jobs
3885+
summary: List Tasks
38863886
description: Lists all long running tasks
3887-
operationId: get_async_jobs
3887+
operationId: list_tasks
38883888
responses:
38893889
'200':
38903890
description: Successful Response
@@ -3920,9 +3920,9 @@ paths:
39203920
get:
39213921
tags:
39223922
- long-running-tasks
3923-
summary: Get Async Job Status
3923+
summary: Get Task Status
39243924
description: Retrieves the status of a task
3925-
operationId: get_async_job_status
3925+
operationId: get_task_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 Async Job
3967+
summary: Cancel Task
39683968
description: Cancels and removes a task
3969-
operationId: cancel_async_job
3969+
operationId: cancel_task
39703970
parameters:
39713971
- name: task_id
39723972
in: path
@@ -4001,13 +4001,57 @@ paths:
40014001
schema:
40024002
$ref: '#/components/schemas/EnvelopedError'
40034003
description: Internal Server Error
4004+
/v0/tasks/{task_id}/stream:
4005+
get:
4006+
tags:
4007+
- long-running-tasks
4008+
summary: Get Task Stream
4009+
description: Retrieves the stream of a task
4010+
operationId: get_task_stream
4011+
parameters:
4012+
- name: task_id
4013+
in: path
4014+
required: true
4015+
schema:
4016+
type: string
4017+
title: Task Id
4018+
responses:
4019+
'200':
4020+
description: Successful Response
4021+
content:
4022+
application/json:
4023+
schema: {}
4024+
'404':
4025+
content:
4026+
application/json:
4027+
schema:
4028+
$ref: '#/components/schemas/EnvelopedError'
4029+
description: Not Found
4030+
'403':
4031+
content:
4032+
application/json:
4033+
schema:
4034+
$ref: '#/components/schemas/EnvelopedError'
4035+
description: Forbidden
4036+
'410':
4037+
content:
4038+
application/json:
4039+
schema:
4040+
$ref: '#/components/schemas/EnvelopedError'
4041+
description: Gone
4042+
'500':
4043+
content:
4044+
application/json:
4045+
schema:
4046+
$ref: '#/components/schemas/EnvelopedError'
4047+
description: Internal Server Error
40044048
/v0/tasks/{task_id}/result:
40054049
get:
40064050
tags:
40074051
- long-running-tasks
4008-
summary: Get Async Job Result
4052+
summary: Get Task Result
40094053
description: Retrieves the result of a task
4010-
operationId: get_async_job_result
4054+
operationId: get_task_result
40114055
parameters:
40124056
- name: task_id
40134057
in: path
@@ -4021,7 +4065,7 @@ paths:
40214065
content:
40224066
application/json:
40234067
schema:
4024-
title: Response Get Async Job Result
4068+
title: Response Get Task Result
40254069
'404':
40264070
content:
40274071
application/json:
@@ -4050,9 +4094,9 @@ paths:
40504094
get:
40514095
tags:
40524096
- long-running-tasks-legacy
4053-
summary: List Tasks
4054-
description: Lists all long running tasks
4055-
operationId: list_tasks
4097+
summary: List Tasks Legacy
4098+
description: Lists all long running tasks (legacy)
4099+
operationId: list_tasks_legacy
40564100
responses:
40574101
'200':
40584102
description: Successful Response
@@ -4064,9 +4108,9 @@ paths:
40644108
get:
40654109
tags:
40664110
- long-running-tasks-legacy
4067-
summary: Get Task Status
4068-
description: Retrieves the status of a task
4069-
operationId: get_task_status
4111+
summary: Get Task Status Legacy
4112+
description: Retrieves the status of a task (legacy)
4113+
operationId: get_task_status_legacy
40704114
parameters:
40714115
- name: task_id
40724116
in: path
@@ -4084,9 +4128,9 @@ paths:
40844128
delete:
40854129
tags:
40864130
- long-running-tasks-legacy
4087-
summary: Remove Task
4088-
description: Cancels and removes a task
4089-
operationId: remove_task
4131+
summary: Remove Task Legacy
4132+
description: Cancels and removes a task (legacy)
4133+
operationId: remove_task_legacy
40904134
parameters:
40914135
- name: task_id
40924136
in: path
@@ -4101,9 +4145,9 @@ paths:
41014145
get:
41024146
tags:
41034147
- long-running-tasks-legacy
4104-
summary: Get Task Result
4105-
description: Retrieves the result of a task
4106-
operationId: get_task_result
4148+
summary: Get Task Result Legacy
4149+
description: Retrieves the result of a task (legacy)
4150+
operationId: get_task_result_legacy
41074151
parameters:
41084152
- name: task_id
41094153
in: path
@@ -4117,7 +4161,7 @@ paths:
41174161
content:
41184162
application/json:
41194163
schema:
4120-
title: Response Get Task Result
4164+
title: Response Get Task Result Legacy
41214165
/v0/catalog/licensed-items:
41224166
get:
41234167
tags:

0 commit comments

Comments
 (0)