hatchet-v2-experimental/api-contracts/openapi/components/schemas/v2/task.yaml at 06207f12a0db589d0990defd36efe7ae9f071b25 · hatchet-dev/hatchet-v2-experimental · 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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
V2TaskSummary:
  properties:
    metadata:
      $ref: ".././metadata.yaml#/APIResourceMeta"
    taskId:
      type: integer
      description: The ID of the task.
    taskInsertedAt:
      type: string
      format: date-time
      description: The timestamp the task was inserted.
    status:
      $ref: "#/V2TaskStatus"
    startedAt:
      type: string
      format: date-time
      description: The timestamp the task run started.
    finishedAt:
      type: string
      format: date-time
      description: The timestamp the task run finished.
    duration:
      type: integer
      description: The duration of the task run, in milliseconds.
    tenantId:
      type: string
      description: The ID of the tenant.
      example: bb214807-246e-43a5-a25d-41761d1cff9e
      minLength: 36
      maxLength: 36
      format: uuid
    additionalMetadata:
      type: object
      description: Additional metadata for the task run.
    displayName:
      type: string
      description: The display name of the task run.
    workflowId:
      type: string
      format: uuid
    output:
      type: object
      description: The output of the task run (for the latest run)
    errorMessage:
      type: string
      description: The error message of the task run (for the latest run)
  required:
    - metadata
    - id
    - taskId
    - taskInsertedAt
    - status
    - tenantId
    - displayName
    - workflowId
    - output

V2DagChildren:
  type: object
  properties:
    dagId:
      type: string
      format: uuid
    children:
      type: array
      items:
        $ref: "#/V2TaskSummary"

V2TaskSummaryList:
  type: object
  properties:
    pagination:
      $ref: ".././metadata.yaml#/PaginationResponse"
    rows:
      type: array
      items:
        $ref: "#/V2TaskSummary"
      description: The list of tasks
  required:
    - pagination
    - rows

V2Task:
  properties:
    metadata:
      $ref: ".././metadata.yaml#/APIResourceMeta"
    taskId:
      type: integer
      description: The ID of the task.
    taskInsertedAt:
      type: string
      format: date-time
      description: The timestamp the task was inserted.
    status:
      $ref: "#/V2TaskStatus"
    startedAt:
      type: string
      format: date-time
      description: The timestamp the task run started.
    finishedAt:
      type: string
      format: date-time
      description: The timestamp the task run finished.
    duration:
      type: integer
      description: The duration of the task run, in milliseconds.
    tenantId:
      type: string
      description: The ID of the tenant.
      example: bb214807-246e-43a5-a25d-41761d1cff9e
      minLength: 36
      maxLength: 36
      format: uuid
    additionalMetadata:
      type: object
      description: Additional metadata for the task run.
    displayName:
      type: string
      description: The display name of the task run.
    workflowId:
      type: string
      format: uuid
    input:
      type: string
      description: The input for the task run.
    output:
      type: string
      description: The output of the task run (for the latest run)
    errorMessage:
      type: string
      description: The error message of the task run (for the latest run)
  required:
    - metadata
    - id
    - taskId
    - taskInsertedAt
    - status
    - tenantId
    - displayName
    - workflowId
    - input

V2TaskEventList:
  properties:
    pagination:
      $ref: ".././metadata.yaml#/PaginationResponse"
    rows:
      items:
        $ref: "#/V2TaskEvent"
      type: array

V2TaskEvent:
  type: object
  properties:
    id:
      type: integer
    taskId:
      type: string
      format: uuid
    timestamp:
      type: string
      format: date-time
    eventType:
      $ref: "#/V2TaskEventType"
    message:
      type: string
    errorMessage:
      type: string
    output:
      type: string
    workerId:
      type: string
      format: uuid
  required:
    - id
    - taskId
    - timestamp
    - eventType
    - message

V2TaskStatus:
  type: string
  enum:
    - QUEUED
    - RUNNING
    - COMPLETED
    - CANCELLED
    - FAILED

V2TaskEventType:
  type: string
  enum:
    - REQUEUED_NO_WORKER
    - REQUEUED_RATE_LIMIT
    - SCHEDULING_TIMED_OUT
    - ASSIGNED
    - STARTED
    - FINISHED
    - FAILED
    - RETRYING
    - CANCELLED
    - TIMED_OUT
    - REASSIGNED
    - SLOT_RELEASED
    - TIMEOUT_REFRESHED
    - RETRIED_BY_USER
    - SENT_TO_WORKER
    - RATE_LIMIT_ERROR
    - ACKNOWLEDGED
    - CREATED
    - QUEUED
    - SKIPPED

V2TaskRunMetrics:
  type: array
  items:
    $ref: "#/V2TaskRunMetric"

V2TaskRunMetric:
  type: object
  properties:
    status:
      $ref: "#/V2TaskStatus"
    count:
      type: integer
  required:
    - status
    - count

V2TaskPointMetric:
  type: object
  properties:
    time:
      type: string
      format: date-time
    SUCCEEDED:
      type: integer
    FAILED:
      type: integer
  required:
    - time
    - SUCCEEDED
    - FAILED

V2TaskPointMetrics:
  type: object
  properties:
    results:
      type: array
      items:
        $ref: "#/V2TaskPointMetric"