/
openapi.yaml
544 lines (544 loc) · 14.9 KB
/
openapi.yaml
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
openapi: 3.1.0
info:
title: Orchestrator plugin
description: API to interact with orchestrator plugin
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 0.0.1
servers:
- url: /
paths:
/v2/workflows/overview:
get:
operationId: getWorkflowsOverview
description: Get a list of workflow overviews
parameters:
- name: page
in: query
description: page number
schema:
type: number
- name: pageSize
in: query
description: page size
schema:
type: number
- name: orderBy
in: query
description: field name to order the data
schema:
type: string
- name: orderDirection
in: query
description: ascending or descending
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowOverviewListResultDTO'
'500':
description: Error fetching workflow overviews
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/workflows/{workflowId}/overview:
get:
operationId: getWorkflowOverviewById
description: Get a workflow overview by ID
parameters:
- name: workflowId
in: path
required: true
description: Unique identifier of the workflow
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowOverviewDTO'
'500':
description: Error fetching workflow overview
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/workflows/{workflowId}:
get:
operationId: getWorkflowById
description: Get a workflow by ID
parameters:
- name: workflowId
in: path
description: ID of the workflow to fetch
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowDTO'
'500':
description: Error fetching workflow by id
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/workflows/{workflowId}/source:
get:
operationId: getWorkflowSourceById
description: Get a workflow source by ID
parameters:
- name: workflowId
in: path
description: ID of the workflow to fetch
required: true
schema:
type: string
responses:
'200':
description: Success
content:
text/plain:
schema:
type: string
'500':
description: Error fetching workflow source by id
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/workflows/instances:
get:
operationId: getInstances
summary: Get instances
description: Retrieve an array of instances
parameters:
- name: page
in: query
description: page number
schema:
type: number
- name: pageSize
in: query
description: page size
schema:
type: number
- name: orderBy
in: query
description: field name to order the data
schema:
type: string
- name: orderDirection
in: query
description: ascending or descending
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessInstanceListResultDTO'
'500':
description: Error fetching instances
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/workflows/instances/{instanceId}:
get:
summary: Get Workflow Instance by ID
operationId: getInstanceById
parameters:
- name: instanceId
in: path
required: true
description: ID of the workflow instance
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessInstanceDTO'
'500':
description: Error fetching instance
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/workflows/instances/{instanceId}/results:
get:
summary: Get workflow results
operationId: getWorkflowResults
parameters:
- name: instanceId
in: path
required: true
description: ID of the workflow instance
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowDataDTO'
'500':
description: Error getting workflow results
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/workflows/instances/statuses:
get:
operationId: getWorkflowStatuses
summary: Get workflow status list
description: Retrieve an array of workflow statuses
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WorkflowRunStatusDTO'
'500':
description: Error fetching workflow statuses
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/workflows/{workflowId}/execute:
post:
summary: Execute a workflow
operationId: executeWorkflow
parameters:
- name: workflowId
in: path
description: ID of the workflow to execute
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExecuteWorkflowRequestDTO'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/ExecuteWorkflowResponseDTO'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/instances/{instanceId}/abort:
delete:
summary: Abort a workflow instance
operationId: abortWorkflow
description: Aborts a workflow instance identified by the provided instanceId.
parameters:
- name: instanceId
in: path
required: true
description: The identifier of the workflow instance to abort.
schema:
type: string
responses:
'200':
description: Successful operation
content:
text/plain:
schema:
type: string
'500':
description: Error aborting workflow
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
ErrorResponse:
description:
The ErrorResponse object represents a common structure for handling errors in API responses.
It includes essential information about the error, such as the error message and additional optional details.
type: object
properties:
message:
description:
A string providing a concise and human-readable description of the encountered error.
This field is required in the ErrorResponse object.
type: string
default: internal server error
additionalInfo:
description:
An optional field that can contain additional information or context about the error.
It provides flexibility for including extra details based on specific error scenarios.
type: string
required:
- message
WorkflowOverviewListResultDTO:
type: object
properties:
overviews:
type: array
items:
$ref: '#/components/schemas/WorkflowOverviewDTO'
paginationInfo:
$ref: '#/components/schemas/PaginationInfoDTO'
WorkflowOverviewDTO:
type: object
properties:
workflowId:
type: string
description: Workflow unique identifier
minLength: 1
name:
type: string
description: Workflow name
minLength: 1
format:
$ref: '#/components/schemas/WorkflowFormatDTO'
lastRunId:
type: string
lastTriggeredMs:
type: number
minimum: 0
lastRunStatus:
type: string
category:
$ref: '#/components/schemas/WorkflowCategoryDTO'
avgDurationMs:
type: number
minimum: 0
description:
type: string
PaginationInfoDTO:
type: object
properties:
pageSize:
type: number
minimum: 0
page:
type: number
minimum: 0
totalCount:
type: number
minimum: 0
additionalProperties: false
WorkflowFormatDTO:
type: string
description: Format of the workflow definition
enum:
- yaml
- json
WorkflowCategoryDTO:
type: string
description: Category of the workflow
enum:
- assessment
- infrastructure
WorkflowListResultDTO:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/WorkflowDTO'
paginationInfo:
$ref: '#/components/schemas/PaginationInfoDTO'
required:
- items
- paginationInfo
WorkflowDTO:
type: object
properties:
id:
type: string
description: Workflow unique identifier
minLength: 1
name:
type: string
description: Workflow name
minLength: 1
format:
$ref: '#/components/schemas/WorkflowFormatDTO'
category:
$ref: '#/components/schemas/WorkflowCategoryDTO'
description:
type: string
description: Description of the workflow
annotations:
type: array
items:
type: string
required:
- id
- category
- format
ProcessInstanceListResultDTO:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ProcessInstanceDTO'
paginationInfo:
$ref: '#/components/schemas/PaginationInfoDTO'
AssessedProcessInstanceDTO:
type: object
properties:
instance:
$ref: '#/components/schemas/ProcessInstanceDTO'
assessedBy:
$ref: '#/components/schemas/ProcessInstanceDTO'
required:
- instance
ProcessInstanceDTO:
type: object
properties:
id:
type: string
name:
type: string
workflow:
type: string
status:
$ref: '#/components/schemas/ProcessInstanceStatusDTO'
start:
type: string
end:
type: string
duration:
type: string
category:
$ref: '#/components/schemas/WorkflowCategoryDTO'
description:
type: string
workflowdata:
$ref: '#/components/schemas/WorkflowDataDTO'
WorkflowDataDTO:
type: object
properties:
workflowoptions:
type: array
items:
$ref: '#/components/schemas/WorkflowOptionsDTO'
additionalProperties: true
WorkflowOptionsDTO:
type: array
items:
$ref: '#/components/schemas/WorkflowSuggestionDTO'
WorkflowSuggestionDTO:
type: object
properties:
id:
type: string
name:
type: string
ProcessInstanceStatusDTO:
type: string
description: Status of the workflow run
enum:
- Running
- Error
- Completed
- Aborted
- Suspended
- Pending
WorkflowRunStatusDTO:
type: object
properties:
key:
type: string
value:
type: string
ExecuteWorkflowRequestDTO:
type: object
properties:
inputData:
type: object
additionalProperties:
type: string
required:
- inputData
ExecuteWorkflowResponseDTO:
type: object
properties:
id:
type: string
WorkflowProgressDTO:
allOf:
- $ref: '#/components/schemas/NodeInstanceDTO'
- type: object
properties:
status:
$ref: '#/components/schemas/ProcessInstanceStatusDTO'
error:
$ref: '#/components/schemas/ProcessInstanceErrorDTO'
NodeInstanceDTO:
type: object
properties:
__typename:
type: string
default: 'NodeInstance'
description: Type name
id:
type: string
description: Node instance ID
name:
type: string
description: Node name
type:
type: string
description: Node type
enter:
type: string
description: Date when the node was entered
exit:
type: string
description: Date when the node was exited (optional)
definitionId:
type: string
description: Definition ID
nodeId:
type: string
description: Node ID
ProcessInstanceErrorDTO:
type: object
properties:
__typename:
type: string
default: 'ProcessInstanceError'
description: Type name
nodeDefinitionId:
type: string
description: Node definition ID
message:
type: string
description: Error message (optional)