forked from windmill-labs/windmill
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenflow.openapi.yaml
More file actions
738 lines (708 loc) · 17 KB
/
openflow.openapi.yaml
File metadata and controls
738 lines (708 loc) · 17 KB
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
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
openapi: "3.0.3"
info:
version: 1.566.1
title: OpenFlow Spec
contact:
name: Ruben Fiszel
email: ruben@windmill.dev
url: https://windmill.dev
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
paths: {}
externalDocs:
description: documentation portal
url: https://windmill.dev
components:
schemas:
OpenFlow:
type: object
properties:
summary:
type: string
description:
type: string
value:
$ref: "#/components/schemas/FlowValue"
schema:
type: object
required:
- summary
- value
FlowValue:
type: object
properties:
modules:
type: array
items:
$ref: "#/components/schemas/FlowModule"
failure_module:
$ref: "#/components/schemas/FlowModule"
preprocessor_module:
$ref: "#/components/schemas/FlowModule"
same_worker:
type: boolean
concurrent_limit:
type: number
concurrency_key:
type: string
concurrency_time_window_s:
type: number
debounce_delay_s:
type: number
debounce_key:
type: string
skip_expr:
type: string
cache_ttl:
type: number
priority:
type: number
early_return:
type: string
chat_input_enabled:
type: boolean
description: Whether this flow accepts chat-style input
required:
- modules
Retry:
type: object
properties:
constant:
type: object
properties:
attempts:
type: integer
seconds:
type: integer
exponential:
type: object
properties:
attempts:
type: integer
multiplier:
type: integer
seconds:
type: integer
random_factor:
type: integer
minimum: 0
maximum: 100
retry_if:
$ref: "#/components/schemas/RetryIf"
RetryIf:
type: object
properties:
expr:
type: string
required:
- expr
StopAfterIf:
type: object
properties:
skip_if_stopped:
type: boolean
expr:
type: string
error_message:
type: string
required:
- expr
FlowModule:
type: object
properties:
id:
type: string
value:
$ref: "#/components/schemas/FlowModuleValue"
stop_after_if:
$ref: "#/components/schemas/StopAfterIf"
stop_after_all_iters_if:
$ref: "#/components/schemas/StopAfterIf"
skip_if:
type: object
properties:
expr:
type: string
required:
- expr
sleep:
$ref: "#/components/schemas/InputTransform"
cache_ttl:
type: number
timeout:
$ref: "#/components/schemas/InputTransform"
delete_after_use:
type: boolean
summary:
type: string
mock:
type: object
properties:
enabled:
type: boolean
return_value: {}
suspend:
type: object
properties:
required_events:
type: integer
timeout:
type: integer
resume_form:
type: object
properties:
schema:
type: object
user_auth_required:
type: boolean
user_groups_required:
$ref: "#/components/schemas/InputTransform"
self_approval_disabled:
type: boolean
hide_cancel:
type: boolean
continue_on_disapprove_timeout:
type: boolean
priority:
type: number
continue_on_error:
type: boolean
retry:
$ref: "#/components/schemas/Retry"
required:
- value
- id
InputTransform:
oneOf:
- $ref: "#/components/schemas/StaticTransform"
- $ref: "#/components/schemas/JavascriptTransform"
discriminator:
propertyName: type
mapping:
static: "#/components/schemas/StaticTransform"
javascript: "#/components/schemas/JavascriptTransform"
StaticTransform:
type: object
properties:
value: {}
type:
type: string
enum:
- static
required:
- type
JavascriptTransform:
type: object
properties:
expr:
type: string
type:
type: string
enum:
- javascript
required:
- expr
- type
FlowModuleValue:
oneOf:
- $ref: "#/components/schemas/RawScript"
- $ref: "#/components/schemas/PathScript"
- $ref: "#/components/schemas/PathFlow"
- $ref: "#/components/schemas/ForloopFlow"
- $ref: "#/components/schemas/WhileloopFlow"
- $ref: "#/components/schemas/BranchOne"
- $ref: "#/components/schemas/BranchAll"
- $ref: "#/components/schemas/Identity"
- $ref: "#/components/schemas/AiAgent"
discriminator:
propertyName: type
mapping:
rawscript: "#/components/schemas/RawScript"
script: "#/components/schemas/PathScript"
flow: "#/components/schemas/PathFlow"
forloopflow: "#/components/schemas/ForloopFlow"
whileloopflow: "#/components/schemas/WhileloopFlow"
branchone: "#/components/schemas/BranchOne"
branchall: "#/components/schemas/BranchAll"
identity: "#/components/schemas/Identity"
aiagent: "#/components/schemas/AiAgent"
RawScript:
type: object
properties:
# to be made required once migration is over
input_transforms:
type: object
additionalProperties:
$ref: "#/components/schemas/InputTransform"
content:
type: string
language:
type: string
enum:
- deno
- bun
- python3
- go
- bash
- powershell
- postgresql
- mysql
- bigquery
- snowflake
- mssql
- oracledb
- graphql
- nativets
- php
# TODO: Add missing languages
path:
type: string
lock:
type: string
type:
type: string
enum:
- rawscript
tag:
type: string
concurrent_limit:
type: number
concurrency_time_window_s:
type: number
custom_concurrency_key:
type: string
is_trigger:
type: boolean
assets:
type: array
items:
type: object
required:
- path
- kind
properties:
path:
type: string
kind:
type: string
enum:
- s3object
- resource
- ducklake
access_type:
type: string
enum: [r, w, rw]
alt_access_type:
type: string
enum: [r, w, rw]
required:
- type
- content
- language
- input_transforms
PathScript:
type: object
properties:
input_transforms:
type: object
additionalProperties:
$ref: "#/components/schemas/InputTransform"
path:
type: string
hash:
type: string
type:
type: string
enum:
- script
tag_override:
type: string
is_trigger:
type: boolean
required:
- type
- path
- input_transforms
PathFlow:
type: object
properties:
input_transforms:
type: object
additionalProperties:
$ref: "#/components/schemas/InputTransform"
path:
type: string
type:
type: string
enum:
- flow
required:
- type
- path
- input_transforms
ForloopFlow:
type: object
properties:
modules:
type: array
items:
$ref: "#/components/schemas/FlowModule"
iterator:
$ref: "#/components/schemas/InputTransform"
skip_failures:
type: boolean
type:
type: string
enum:
- forloopflow
parallel:
type: boolean
parallelism:
$ref: "#/components/schemas/InputTransform"
required:
- modules
- iterator
- skip_failures
- type
WhileloopFlow:
type: object
properties:
modules:
type: array
items:
$ref: "#/components/schemas/FlowModule"
skip_failures:
type: boolean
type:
type: string
enum:
- whileloopflow
parallel:
type: boolean
parallelism:
$ref: "#/components/schemas/InputTransform"
required:
- modules
- skip_failures
- type
BranchOne:
type: object
properties:
branches:
type: array
items:
type: object
properties:
summary:
type: string
expr:
type: string
modules:
type: array
items:
$ref: "#/components/schemas/FlowModule"
required:
- modules
- expr
default:
type: array
items:
$ref: "#/components/schemas/FlowModule"
required: [modules]
type:
type: string
enum:
- branchone
required:
- branches
- default
- type
BranchAll:
type: object
properties:
branches:
type: array
items:
type: object
properties:
summary:
type: string
skip_failure:
type: boolean
modules:
type: array
items:
$ref: "#/components/schemas/FlowModule"
required:
- modules
type:
type: string
enum:
- branchall
parallel:
type: boolean
required:
- branches
- type
AgentTool:
type: object
properties:
id:
type: string
summary:
type: string
value:
$ref: "#/components/schemas/ToolValue"
required:
- id
- value
ToolValue:
oneOf:
- $ref: "#/components/schemas/FlowModuleTool"
- $ref: "#/components/schemas/McpToolValue"
discriminator:
propertyName: tool_type
mapping:
flowmodule: "#/components/schemas/FlowModuleTool"
mcp: "#/components/schemas/McpToolValue"
FlowModuleTool:
allOf:
- type: object
properties:
tool_type:
type: string
enum:
- flowmodule
required:
- tool_type
- $ref: "#/components/schemas/FlowModuleValue"
McpToolValue:
type: object
properties:
tool_type:
type: string
enum:
- mcp
resource_path:
type: string
include_tools:
type: array
items:
type: string
exclude_tools:
type: array
items:
type: string
required:
- tool_type
- resource_path
AiAgent:
type: object
properties:
input_transforms:
type: object
additionalProperties:
$ref: "#/components/schemas/InputTransform"
tools:
type: array
items:
$ref: "#/components/schemas/AgentTool"
type:
type: string
enum:
- aiagent
parallel:
type: boolean
required:
- tools
- type
- input_transforms
Identity:
type: object
properties:
type:
type: string
enum:
- identity
flow:
type: boolean
required:
- type
FlowStatus:
type: object
properties:
step:
type: integer
modules:
type: array
items:
$ref: "#/components/schemas/FlowStatusModule"
user_states:
additionalProperties: true
preprocessor_module:
allOf:
- $ref: "#/components/schemas/FlowStatusModule"
failure_module:
allOf:
- $ref: "#/components/schemas/FlowStatusModule"
- type: object
properties:
parent_module:
type: string
retry:
type: object
properties:
fail_count:
type: integer
failed_jobs:
type: array
items:
type: string
format: uuid
required:
- step
- modules
- failure_module
FlowStatusModule:
type: object
properties:
type:
type: string
enum:
- WaitingForPriorSteps
- WaitingForEvents
- WaitingForExecutor
- InProgress
- Success
- Failure
id:
type: string
job:
type: string
format: uuid
count:
type: integer
progress:
type: integer
iterator:
type: object
properties:
index:
type: integer
itered:
type: array
items: {}
args: {}
flow_jobs:
type: array
items:
type: string
flow_jobs_success:
type: array
items:
type: boolean
flow_jobs_duration:
type: object
properties:
started_at:
type: array
items:
type: string
duration_ms:
type: array
items:
type: integer
branch_chosen:
type: object
properties:
type:
type: string
enum: [branch, default]
branch:
type: integer
required:
- type
branchall:
type: object
properties:
branch:
type: integer
len:
type: integer
required:
- branch
- len
approvers:
type: array
items:
type: object
properties:
resume_id:
type: integer
approver:
type: string
required:
- resume_id
- approver
failed_retries:
type: array
items:
type: string
format: uuid
skipped:
type: boolean
agent_actions:
type: array
items:
type: object
oneOf:
- type: object
properties:
job_id:
type: string
format: uuid
function_name:
type: string
type:
type: string
enum: [tool_call]
module_id:
type: string
required:
- job_id
- function_name
- type
- module_id
- type: object
properties:
call_id:
type: string
format: uuid
function_name:
type: string
resource_path:
type: string
type:
type: string
enum: [mcp_tool_call]
arguments:
type: object
required:
- call_id
- function_name
- resource_path
- type
- type: object
properties:
type:
type: string
enum: [message]
required:
- content
- type
agent_actions_success:
type: array
items:
type: boolean
required: [type]