job-tracker/openapi3.yaml at master · MapColonies/job-tracker · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
openapi: 3.0.1
info:
  title: job-tracker
  description: A service that exposes a dedicated API for jobs and tasks states tracking
  version: 5.2.1
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
security: []
paths:
  /tasks/{taskId}/notify:
    parameters:
      - $ref: '#/components/parameters/taskId'
    post:
      operationId: handleTaskNotification
      tags:
        - tasks
      summary: notify tracker on task finished
      responses:
        '200':
          description: OK
        '400':
          description: Bad task id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Task not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '428':
          description: Task neither in "Completed" nor "Failed" status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
components:
  parameters:
    taskId:
      in: path
      name: taskId
      description: ID of task
      required: true
      schema:
        $ref: '#/components/schemas/taskId'
  schemas:
    taskId:
      type: string
      format: uuid
    error:
      type: object
      properties:
        message:
          type: string
        stacktrace:
          type: string
      required:
        - message