Skip to content

Commit

Permalink
added callback specs
Browse files Browse the repository at this point in the history
  • Loading branch information
sgalpha01 authored Jun 27, 2022
1 parent 36181ff commit e0bbd76
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions openapi/task_execution_service.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,21 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/tesCreateTaskResponse'
callbacks:
statusChange:
'{$request.body#/callback_url}':
post:
requestBody:
description: ""
content:
application/json:
schema:
$ref: '#/components/schemas/tesTaskStatusChangeNotification'
responses:
202:
description: |-
Listener should return this HTTP status code if
the payload was received successfully.
x-codegen-request-body-name: body
/tasks/{id}:
get:
Expand Down Expand Up @@ -654,6 +669,12 @@ components:
type: string
description: |-
Optional user-provided description of task for documentation purposes.
callback_url:
type: string
format: uri
description: |-
Optional user-provided callback URL for task status updates.
example: https://myserver.com/send/callback/here
inputs:
type: array
description: |-
Expand Down Expand Up @@ -741,6 +762,19 @@ components:
example: 2020-10-02T10:00:00-05:00
readOnly: true
description: Task describes an instance of a task.
tesTaskStatusChangeNotification:
type: object
required:
- task_id
- state
properties:
task_id:
type: string
description: Task identifier assigned by the server.
example: job-0012345
state:
$ref: '#/components/schemas/tesState'
description: Notification that a task has changed state.
tesTaskLog:
required:
- logs
Expand Down

0 comments on commit e0bbd76

Please sign in to comment.