Skip to content

Commit e0bbd76

Browse files
authored
added callback specs
1 parent 36181ff commit e0bbd76

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

openapi/task_execution_service.openapi.yaml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,21 @@ paths:
146146
application/json:
147147
schema:
148148
$ref: '#/components/schemas/tesCreateTaskResponse'
149+
callbacks:
150+
statusChange:
151+
'{$request.body#/callback_url}':
152+
post:
153+
requestBody:
154+
description: ""
155+
content:
156+
application/json:
157+
schema:
158+
$ref: '#/components/schemas/tesTaskStatusChangeNotification'
159+
responses:
160+
202:
161+
description: |-
162+
Listener should return this HTTP status code if
163+
the payload was received successfully.
149164
x-codegen-request-body-name: body
150165
/tasks/{id}:
151166
get:
@@ -654,6 +669,12 @@ components:
654669
type: string
655670
description: |-
656671
Optional user-provided description of task for documentation purposes.
672+
callback_url:
673+
type: string
674+
format: uri
675+
description: |-
676+
Optional user-provided callback URL for task status updates.
677+
example: https://myserver.com/send/callback/here
657678
inputs:
658679
type: array
659680
description: |-
@@ -741,6 +762,19 @@ components:
741762
example: 2020-10-02T10:00:00-05:00
742763
readOnly: true
743764
description: Task describes an instance of a task.
765+
tesTaskStatusChangeNotification:
766+
type: object
767+
required:
768+
- task_id
769+
- state
770+
properties:
771+
task_id:
772+
type: string
773+
description: Task identifier assigned by the server.
774+
example: job-0012345
775+
state:
776+
$ref: '#/components/schemas/tesState'
777+
description: Notification that a task has changed state.
744778
tesTaskLog:
745779
required:
746780
- logs

0 commit comments

Comments
 (0)