Skip to content

Commit b0f5964

Browse files
committed
added callback specs
1 parent 07d8791 commit b0f5964

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

openapi/task_execution_service.openapi.yaml

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ paths:
151151
'{$request.body#/callback_url}':
152152
post:
153153
description: |-
154-
The API will send notifications to the callback URL, if provided,
154+
The TES server will send notifications to the callback URL, if provided,
155155
when the task status changes.
156156
requestBody:
157157
content:
@@ -236,6 +236,19 @@ components:
236236
- FULL
237237

238238
schemas:
239+
tesCallbackStatus:
240+
type: object
241+
required:
242+
- id
243+
- state
244+
properties:
245+
id:
246+
type: string
247+
description: Task identifier assigned by the server.
248+
example: job-0012345
249+
state:
250+
$ref: '#/components/schemas/tesState'
251+
description: Notification that a task has changed state.
239252
tesCancelTaskResponse:
240253
type: object
241254
description: CancelTaskResponse describes a response from the CancelTask endpoint.
@@ -675,9 +688,7 @@ components:
675688
type: string
676689
format: uri
677690
description: |-
678-
Optional user-provided callback URL. Note that the URL can be
679-
provided while creating a new task, but it MUST NOT be displayed when
680-
a task or a list of tasks is returned by the TES server.
691+
Optional user-provided callback URL.
681692
example: https://myserver.com/send/callback/here
682693
inputs:
683694
type: array
@@ -765,20 +776,7 @@ components:
765776
This is set by the system, not the client.
766777
example: 2020-10-02T10:00:00-05:00
767778
readOnly: true
768-
description: Task describes an instance of a task.
769-
tesCallbackStatus:
770-
type: object
771-
required:
772-
- task_id
773-
- state
774-
properties:
775-
task_id:
776-
type: string
777-
description: Task identifier assigned by the server.
778-
example: job-0012345
779-
state:
780-
$ref: '#/components/schemas/tesState'
781-
description: Notification that a task has changed state.
779+
description: Task describes an instance of a task.
782780
tesTaskLog:
783781
required:
784782
- logs

0 commit comments

Comments
 (0)