hatchet-v2-experimental/api-contracts/openapi/paths/v2/tasks/tasks.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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
listTasks:
  get:
    x-resources: ["tenant"]
    description: Lists all tasks for a tenant.
    operationId: v2-task:list
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The number to skip
        in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int64
      - description: The number to limit by
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int64
      - description: A list of task statuses to filter by
        in: query
        name: statuses
        required: false
        schema:
          type: array
          items:
            $ref: "../../../components/schemas/_index.yaml#/V2TaskStatus"
      - description: The earliest date to filter by
        in: query
        name: since
        required: true
        schema:
          type: string
          format: date-time
      - description: The earliest date to filter by
        in: query
        name: until
        required: false
        schema:
          type: string
          format: date-time
      - description: Additional metadata k-v pairs to filter by
        in: query
        name: additional_metadata
        required: false
        schema:
          type: array
          items:
            type: string
      - description: The workflow ids to find runs for
        in: query
        name: workflow_ids
        required: false
        schema:
          type: array
          items:
            type: string
            format: uuid
            minLength: 36
            maxLength: 36
      - description: The worker id to filter by
        in: query
        name: worker_id
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/V2TaskSummaryList"
        description: Successfully listed the tasks
      "400":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: List tasks
    tags:
      - Task

listTasksByDAGIds:
  get:
    description: Lists all tasks that belong a specific list of dags
    operationId: v2-dag:list:tasks
    parameters:
      - description: The external id of the DAG
        in: query
        name: dag_ids
        required: true
        schema:
          type: array
          items:
            type: string
            format: uuid
            minLength: 36
            maxLength: 36
      - description: The tenant id
        in: query
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "200":
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: "../../../components/schemas/_index.yaml#/V2DagChildren"
              description: The list of tasks
        description: Successfully listed the tasks
      "400":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: List tasks
    tags:
      - Task

getTask:
  get:
    x-resources: ["tenant", "task"]
    description: Get a task by id
    operationId: v2-task:get
    parameters:
      - description: The task id
        in: path
        name: task
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/V2Task"
        description: Successfully retrieved the task
      "400":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
      "404":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
        description: The task was not found
    summary: Get a task
    tags:
      - Task

listTaskEvents:
  get:
    x-resources: ["tenant", "task"]
    description: List events for a task
    operationId: v2-task-event:list
    parameters:
      - description: The task id
        in: path
        name: task
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The number to skip
        in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int64
      - description: The number to limit by
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int64
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/V2TaskEventList"
        description: Successfully retrieved the events
      "400":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
      "404":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
        description: The task was not found
    summary: List events for a task
    tags:
      - Task

getTaskStatusMetrics:
  get:
    x-resources: ["tenant"]
    description: Get a summary of task run metrics for a tenant
    operationId: v2-task:list:status-metrics
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The start time to get metrics for
        in: query
        name: since
        required: true
        schema:
          type: string
          format: date-time
      - description: The workflow id to find runs for
        in: query
        name: workflow_ids
        required: false
        schema:
          type: array
          items:
            type: string
            format: uuid
            minLength: 36
            maxLength: 36
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/V2TaskRunMetrics"
        description: Successfully retrieved the task run metrics
      "400":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Get task metrics
    tags:
      - Task

getTaskPointMetrics:
  get:
    x-resources: ["tenant"]
    description: Get a minute by minute breakdown of task metrics for a tenant
    operationId: v2-task:get:point-metrics
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The time after the task was created
        in: query
        name: createdAfter
        example: "2021-01-01T00:00:00Z"
        required: false
        schema:
          type: string
          format: date-time
      - description: The time before the task was completed
        in: query
        name: finishedBefore
        example: "2021-01-01T00:00:00Z"
        required: false
        schema:
          type: string
          format: date-time
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/V2TaskPointMetrics"
        description: Successfully retrieved the task point metrics
      "400":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Get task point metrics
    tags:
      - Task