dataiku-sdk 3.3.0 → 3.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/README.md +3 -1
  2. package/dist/build-metadata.json +1 -1
  3. package/dist/src/cli/commands/code.js +1 -1
  4. package/dist/src/cli/commands/dataset.js +1 -1
  5. package/dist/src/cli/commands/job.js +4 -2
  6. package/dist/src/cli/commands/macro.js +2 -2
  7. package/dist/src/cli/commands/project-git.js +1 -1
  8. package/dist/src/cli/commands/scenario.js +1 -1
  9. package/dist/src/cli/contract.js +23 -208
  10. package/dist/src/cli/output-schemas.d.ts +24 -0
  11. package/dist/src/cli/output-schemas.js +233 -0
  12. package/dist/src/client.d.ts +10 -1
  13. package/dist/src/client.js +20 -5
  14. package/dist/src/errors.js +6 -4
  15. package/dist/src/generated/action-output-schemas.json +1735 -0
  16. package/dist/src/resources/datasets.js +37 -4
  17. package/dist/src/resources/flow-zones.d.ts +6 -2
  18. package/dist/src/resources/flow-zones.js +6 -3
  19. package/dist/src/resources/futures.d.ts +2 -0
  20. package/dist/src/resources/futures.js +38 -24
  21. package/dist/src/resources/jobs.js +37 -25
  22. package/dist/src/resources/ml-tasks.js +28 -19
  23. package/dist/src/resources/plugins.d.ts +0 -2
  24. package/dist/src/resources/plugins.js +0 -3
  25. package/dist/src/resources/project-git.d.ts +6 -12
  26. package/dist/src/resources/project-git.js +23 -48
  27. package/dist/src/resources/projects.d.ts +4 -2
  28. package/dist/src/resources/projects.js +33 -33
  29. package/dist/src/utils/git-reference.d.ts +12 -0
  30. package/dist/src/utils/git-reference.js +38 -0
  31. package/package.json +5 -5
  32. package/plugin.json +1 -1
  33. package/skills/dataiku-dss/SKILL.md +4 -2
  34. package/skills/dataiku-dss/references/app-releases.md +2 -3
  35. package/skills/dataiku-dss/references/authentication.md +6 -6
  36. package/skills/dataiku-dss/references/mutations.md +1 -1
  37. package/skills/dataiku-dss/references/troubleshooting.md +2 -2
@@ -0,0 +1,1735 @@
1
+ {
2
+ "format": 1,
3
+ "schemas": {
4
+ "code-env.get": {
5
+ "type": "object",
6
+ "required": [
7
+ "envName",
8
+ "envLang",
9
+ "requestedPackages",
10
+ "installedPackages"
11
+ ],
12
+ "properties": {
13
+ "envName": {
14
+ "type": "string"
15
+ },
16
+ "envLang": {
17
+ "type": "string"
18
+ },
19
+ "pythonInterpreter": {
20
+ "type": "string"
21
+ },
22
+ "deploymentMode": {
23
+ "type": "string"
24
+ },
25
+ "requestedPackages": {
26
+ "type": "array",
27
+ "items": {
28
+ "type": "string"
29
+ }
30
+ },
31
+ "installedPackages": {
32
+ "type": "array",
33
+ "items": {
34
+ "type": "string"
35
+ }
36
+ },
37
+ "definitionHash": {
38
+ "type": "string"
39
+ }
40
+ }
41
+ },
42
+ "code-env.get-log": {
43
+ "oneOf": [
44
+ {
45
+ "type": "object",
46
+ "required": [
47
+ "log",
48
+ "bytes",
49
+ "truncated",
50
+ "tailed",
51
+ "envLang",
52
+ "envName",
53
+ "logName"
54
+ ],
55
+ "properties": {
56
+ "log": {
57
+ "type": "string"
58
+ },
59
+ "bytes": {
60
+ "type": "integer",
61
+ "minimum": 0
62
+ },
63
+ "truncated": {
64
+ "type": "boolean"
65
+ },
66
+ "tailed": {
67
+ "type": "boolean"
68
+ },
69
+ "envLang": {
70
+ "enum": [
71
+ "PYTHON",
72
+ "R"
73
+ ]
74
+ },
75
+ "envName": {
76
+ "type": "string"
77
+ },
78
+ "logName": {
79
+ "type": "string"
80
+ }
81
+ }
82
+ },
83
+ {
84
+ "type": "object",
85
+ "required": [
86
+ "path",
87
+ "bytes",
88
+ "truncated",
89
+ "tailed",
90
+ "envLang",
91
+ "envName",
92
+ "logName"
93
+ ],
94
+ "properties": {
95
+ "path": {
96
+ "type": "string"
97
+ },
98
+ "bytes": {
99
+ "type": "integer",
100
+ "minimum": 0
101
+ },
102
+ "truncated": {
103
+ "type": "boolean"
104
+ },
105
+ "tailed": {
106
+ "type": "boolean"
107
+ },
108
+ "envLang": {
109
+ "enum": [
110
+ "PYTHON",
111
+ "R"
112
+ ]
113
+ },
114
+ "envName": {
115
+ "type": "string"
116
+ },
117
+ "logName": {
118
+ "type": "string"
119
+ }
120
+ }
121
+ }
122
+ ]
123
+ },
124
+ "code-env.list": {
125
+ "type": "array",
126
+ "items": {
127
+ "additionalProperties": true,
128
+ "type": "object",
129
+ "required": [
130
+ "envName",
131
+ "envLang"
132
+ ],
133
+ "properties": {
134
+ "envName": {
135
+ "type": "string"
136
+ },
137
+ "envLang": {
138
+ "type": "string"
139
+ },
140
+ "deploymentMode": {
141
+ "type": "string"
142
+ }
143
+ }
144
+ }
145
+ },
146
+ "code-env.list-logs": {
147
+ "type": "array",
148
+ "items": {
149
+ "additionalProperties": true,
150
+ "type": "object",
151
+ "required": [
152
+ "name"
153
+ ],
154
+ "properties": {
155
+ "name": {
156
+ "type": "string"
157
+ }
158
+ }
159
+ }
160
+ },
161
+ "code-env.usages": {
162
+ "type": "array",
163
+ "items": {
164
+ "type": "object",
165
+ "patternProperties": {
166
+ "^(.*)$": {}
167
+ }
168
+ }
169
+ },
170
+ "code-env.version": {
171
+ "additionalProperties": true,
172
+ "type": "object",
173
+ "properties": {
174
+ "version": {
175
+ "type": "string"
176
+ },
177
+ "bundleId": {
178
+ "type": "string"
179
+ }
180
+ }
181
+ },
182
+ "code.run": {
183
+ "type": "object",
184
+ "additionalProperties": false,
185
+ "required": [
186
+ "outcome",
187
+ "success",
188
+ "runId",
189
+ "elapsedMs",
190
+ "pollCount",
191
+ "output",
192
+ "logTruncated",
193
+ "maxLogBytes",
194
+ "cleanup"
195
+ ],
196
+ "properties": {
197
+ "outcome": {
198
+ "type": "string"
199
+ },
200
+ "success": {
201
+ "type": "boolean"
202
+ },
203
+ "runId": {
204
+ "type": "string"
205
+ },
206
+ "elapsedMs": {
207
+ "type": "number",
208
+ "minimum": 0
209
+ },
210
+ "pollCount": {
211
+ "type": "integer",
212
+ "minimum": 0
213
+ },
214
+ "output": {
215
+ "type": "string"
216
+ },
217
+ "log": {
218
+ "type": "string"
219
+ },
220
+ "logTruncated": {
221
+ "type": "boolean"
222
+ },
223
+ "maxLogBytes": {
224
+ "type": "integer",
225
+ "minimum": 0
226
+ },
227
+ "timedOut": {
228
+ "const": true
229
+ },
230
+ "timeoutMs": {
231
+ "type": "integer",
232
+ "minimum": 0
233
+ },
234
+ "cleanup": {
235
+ "type": "object",
236
+ "additionalProperties": false,
237
+ "required": [
238
+ "status"
239
+ ],
240
+ "properties": {
241
+ "status": {
242
+ "enum": [
243
+ "deleted",
244
+ "kept",
245
+ "failed"
246
+ ]
247
+ },
248
+ "error": {
249
+ "type": "string"
250
+ }
251
+ }
252
+ }
253
+ }
254
+ },
255
+ "dataset.get": {
256
+ "additionalProperties": true,
257
+ "type": "object",
258
+ "required": [
259
+ "name"
260
+ ],
261
+ "properties": {
262
+ "name": {
263
+ "type": "string"
264
+ },
265
+ "type": {
266
+ "type": "string"
267
+ },
268
+ "projectKey": {
269
+ "type": "string"
270
+ },
271
+ "managed": {
272
+ "type": "boolean"
273
+ },
274
+ "params": {
275
+ "additionalProperties": true,
276
+ "type": "object",
277
+ "properties": {
278
+ "connection": {
279
+ "type": "string"
280
+ },
281
+ "uploadConnection": {
282
+ "type": "string"
283
+ },
284
+ "path": {
285
+ "type": "string"
286
+ },
287
+ "table": {
288
+ "type": "string"
289
+ },
290
+ "schema": {
291
+ "type": "string"
292
+ },
293
+ "catalog": {
294
+ "type": "string"
295
+ },
296
+ "folderSmartId": {
297
+ "type": "string"
298
+ }
299
+ }
300
+ },
301
+ "formatType": {
302
+ "type": "string"
303
+ },
304
+ "formatParams": {
305
+ "additionalProperties": true,
306
+ "type": "object",
307
+ "properties": {
308
+ "separator": {
309
+ "type": "string"
310
+ },
311
+ "charset": {
312
+ "type": "string"
313
+ },
314
+ "compress": {
315
+ "type": "string"
316
+ }
317
+ }
318
+ },
319
+ "schema": {
320
+ "additionalProperties": true,
321
+ "type": "object",
322
+ "required": [
323
+ "columns"
324
+ ],
325
+ "properties": {
326
+ "columns": {
327
+ "type": "array",
328
+ "items": {
329
+ "additionalProperties": true,
330
+ "type": "object",
331
+ "required": [
332
+ "name",
333
+ "type"
334
+ ],
335
+ "properties": {
336
+ "name": {
337
+ "type": "string"
338
+ },
339
+ "type": {
340
+ "type": "string"
341
+ },
342
+ "comment": {
343
+ "type": "string"
344
+ }
345
+ }
346
+ }
347
+ }
348
+ }
349
+ },
350
+ "tags": {
351
+ "type": "array",
352
+ "items": {
353
+ "type": "string"
354
+ }
355
+ },
356
+ "shortDesc": {
357
+ "type": "string"
358
+ }
359
+ }
360
+ },
361
+ "dataset.list": {
362
+ "type": "array",
363
+ "items": {
364
+ "additionalProperties": true,
365
+ "type": "object",
366
+ "required": [
367
+ "name"
368
+ ],
369
+ "properties": {
370
+ "name": {
371
+ "type": "string"
372
+ },
373
+ "type": {
374
+ "type": "string"
375
+ },
376
+ "shortDesc": {
377
+ "type": "string"
378
+ },
379
+ "managed": {
380
+ "type": "boolean"
381
+ },
382
+ "params": {
383
+ "additionalProperties": true,
384
+ "type": "object",
385
+ "properties": {
386
+ "connection": {
387
+ "type": "string"
388
+ },
389
+ "uploadConnection": {
390
+ "type": "string"
391
+ },
392
+ "schema": {
393
+ "type": "string"
394
+ },
395
+ "catalog": {
396
+ "type": "string"
397
+ }
398
+ }
399
+ }
400
+ }
401
+ }
402
+ },
403
+ "dataset.schema": {
404
+ "additionalProperties": true,
405
+ "type": "object",
406
+ "required": [
407
+ "columns"
408
+ ],
409
+ "properties": {
410
+ "columns": {
411
+ "type": "array",
412
+ "items": {
413
+ "additionalProperties": true,
414
+ "type": "object",
415
+ "required": [
416
+ "name",
417
+ "type"
418
+ ],
419
+ "properties": {
420
+ "name": {
421
+ "type": "string"
422
+ },
423
+ "type": {
424
+ "type": "string"
425
+ },
426
+ "comment": {
427
+ "type": "string"
428
+ }
429
+ }
430
+ }
431
+ }
432
+ }
433
+ },
434
+ "flow-zone.get": {
435
+ "additionalProperties": true,
436
+ "type": "object",
437
+ "required": [
438
+ "id",
439
+ "name"
440
+ ],
441
+ "properties": {
442
+ "id": {
443
+ "type": "string"
444
+ },
445
+ "name": {
446
+ "type": "string"
447
+ },
448
+ "color": {
449
+ "type": "string"
450
+ },
451
+ "projectKey": {
452
+ "type": "string"
453
+ },
454
+ "items": {
455
+ "type": "array",
456
+ "items": {
457
+ "additionalProperties": true,
458
+ "type": "object",
459
+ "required": [
460
+ "objectId",
461
+ "objectType"
462
+ ],
463
+ "properties": {
464
+ "objectId": {
465
+ "type": "string"
466
+ },
467
+ "objectType": {
468
+ "anyOf": [
469
+ {
470
+ "const": "DATASET",
471
+ "type": "string"
472
+ },
473
+ {
474
+ "const": "MANAGED_FOLDER",
475
+ "type": "string"
476
+ },
477
+ {
478
+ "const": "SAVED_MODEL",
479
+ "type": "string"
480
+ },
481
+ {
482
+ "const": "RECIPE",
483
+ "type": "string"
484
+ },
485
+ {
486
+ "const": "MODEL_EVALUATION_STORE",
487
+ "type": "string"
488
+ },
489
+ {
490
+ "const": "STREAMING_ENDPOINT",
491
+ "type": "string"
492
+ },
493
+ {
494
+ "const": "LABELING_TASK",
495
+ "type": "string"
496
+ },
497
+ {
498
+ "const": "RETRIEVABLE_KNOWLEDGE",
499
+ "type": "string"
500
+ }
501
+ ]
502
+ },
503
+ "projectKey": {
504
+ "type": "string"
505
+ }
506
+ }
507
+ }
508
+ },
509
+ "shared": {
510
+ "type": "array",
511
+ "items": {
512
+ "additionalProperties": true,
513
+ "type": "object",
514
+ "required": [
515
+ "objectId",
516
+ "objectType"
517
+ ],
518
+ "properties": {
519
+ "objectId": {
520
+ "type": "string"
521
+ },
522
+ "objectType": {
523
+ "anyOf": [
524
+ {
525
+ "const": "DATASET",
526
+ "type": "string"
527
+ },
528
+ {
529
+ "const": "MANAGED_FOLDER",
530
+ "type": "string"
531
+ },
532
+ {
533
+ "const": "SAVED_MODEL",
534
+ "type": "string"
535
+ },
536
+ {
537
+ "const": "RECIPE",
538
+ "type": "string"
539
+ },
540
+ {
541
+ "const": "MODEL_EVALUATION_STORE",
542
+ "type": "string"
543
+ },
544
+ {
545
+ "const": "STREAMING_ENDPOINT",
546
+ "type": "string"
547
+ },
548
+ {
549
+ "const": "LABELING_TASK",
550
+ "type": "string"
551
+ },
552
+ {
553
+ "const": "RETRIEVABLE_KNOWLEDGE",
554
+ "type": "string"
555
+ }
556
+ ]
557
+ },
558
+ "projectKey": {
559
+ "type": "string"
560
+ }
561
+ }
562
+ }
563
+ },
564
+ "position": {
565
+ "additionalProperties": false,
566
+ "type": "object",
567
+ "required": [
568
+ "x",
569
+ "y"
570
+ ],
571
+ "properties": {
572
+ "x": {
573
+ "type": "number"
574
+ },
575
+ "y": {
576
+ "type": "number"
577
+ }
578
+ }
579
+ }
580
+ }
581
+ },
582
+ "flow-zone.list": {
583
+ "type": "array",
584
+ "items": {
585
+ "additionalProperties": true,
586
+ "type": "object",
587
+ "required": [
588
+ "id",
589
+ "name"
590
+ ],
591
+ "properties": {
592
+ "id": {
593
+ "type": "string"
594
+ },
595
+ "name": {
596
+ "type": "string"
597
+ },
598
+ "color": {
599
+ "type": "string"
600
+ },
601
+ "projectKey": {
602
+ "type": "string"
603
+ },
604
+ "items": {
605
+ "type": "array",
606
+ "items": {
607
+ "additionalProperties": true,
608
+ "type": "object",
609
+ "required": [
610
+ "objectId",
611
+ "objectType"
612
+ ],
613
+ "properties": {
614
+ "objectId": {
615
+ "type": "string"
616
+ },
617
+ "objectType": {
618
+ "anyOf": [
619
+ {
620
+ "const": "DATASET",
621
+ "type": "string"
622
+ },
623
+ {
624
+ "const": "MANAGED_FOLDER",
625
+ "type": "string"
626
+ },
627
+ {
628
+ "const": "SAVED_MODEL",
629
+ "type": "string"
630
+ },
631
+ {
632
+ "const": "RECIPE",
633
+ "type": "string"
634
+ },
635
+ {
636
+ "const": "MODEL_EVALUATION_STORE",
637
+ "type": "string"
638
+ },
639
+ {
640
+ "const": "STREAMING_ENDPOINT",
641
+ "type": "string"
642
+ },
643
+ {
644
+ "const": "LABELING_TASK",
645
+ "type": "string"
646
+ },
647
+ {
648
+ "const": "RETRIEVABLE_KNOWLEDGE",
649
+ "type": "string"
650
+ }
651
+ ]
652
+ },
653
+ "projectKey": {
654
+ "type": "string"
655
+ }
656
+ }
657
+ }
658
+ },
659
+ "shared": {
660
+ "type": "array",
661
+ "items": {
662
+ "additionalProperties": true,
663
+ "type": "object",
664
+ "required": [
665
+ "objectId",
666
+ "objectType"
667
+ ],
668
+ "properties": {
669
+ "objectId": {
670
+ "type": "string"
671
+ },
672
+ "objectType": {
673
+ "anyOf": [
674
+ {
675
+ "const": "DATASET",
676
+ "type": "string"
677
+ },
678
+ {
679
+ "const": "MANAGED_FOLDER",
680
+ "type": "string"
681
+ },
682
+ {
683
+ "const": "SAVED_MODEL",
684
+ "type": "string"
685
+ },
686
+ {
687
+ "const": "RECIPE",
688
+ "type": "string"
689
+ },
690
+ {
691
+ "const": "MODEL_EVALUATION_STORE",
692
+ "type": "string"
693
+ },
694
+ {
695
+ "const": "STREAMING_ENDPOINT",
696
+ "type": "string"
697
+ },
698
+ {
699
+ "const": "LABELING_TASK",
700
+ "type": "string"
701
+ },
702
+ {
703
+ "const": "RETRIEVABLE_KNOWLEDGE",
704
+ "type": "string"
705
+ }
706
+ ]
707
+ },
708
+ "projectKey": {
709
+ "type": "string"
710
+ }
711
+ }
712
+ }
713
+ },
714
+ "position": {
715
+ "additionalProperties": false,
716
+ "type": "object",
717
+ "required": [
718
+ "x",
719
+ "y"
720
+ ],
721
+ "properties": {
722
+ "x": {
723
+ "type": "number"
724
+ },
725
+ "y": {
726
+ "type": "number"
727
+ }
728
+ }
729
+ }
730
+ }
731
+ }
732
+ },
733
+ "job.list": {
734
+ "type": "array",
735
+ "items": {
736
+ "additionalProperties": true,
737
+ "type": "object",
738
+ "properties": {
739
+ "def": {
740
+ "additionalProperties": true,
741
+ "type": "object",
742
+ "properties": {
743
+ "id": {
744
+ "type": "string"
745
+ },
746
+ "type": {
747
+ "type": "string"
748
+ }
749
+ }
750
+ },
751
+ "baseStatus": {
752
+ "additionalProperties": true,
753
+ "type": "object",
754
+ "properties": {
755
+ "def": {
756
+ "additionalProperties": true,
757
+ "type": "object",
758
+ "properties": {
759
+ "id": {
760
+ "type": "string"
761
+ },
762
+ "type": {
763
+ "type": "string"
764
+ }
765
+ }
766
+ },
767
+ "state": {
768
+ "type": "string"
769
+ }
770
+ }
771
+ }
772
+ }
773
+ }
774
+ },
775
+ "job.monitor": {
776
+ "type": "object",
777
+ "required": [
778
+ "jobId",
779
+ "state",
780
+ "type",
781
+ "elapsedMs",
782
+ "pollCount",
783
+ "success",
784
+ "progress"
785
+ ],
786
+ "properties": {
787
+ "jobId": {
788
+ "type": "string"
789
+ },
790
+ "state": {
791
+ "type": "string"
792
+ },
793
+ "type": {
794
+ "type": "string"
795
+ },
796
+ "elapsedMs": {
797
+ "type": "number"
798
+ },
799
+ "pollCount": {
800
+ "type": "number"
801
+ },
802
+ "success": {
803
+ "type": "boolean"
804
+ },
805
+ "timedOut": {
806
+ "type": "boolean"
807
+ },
808
+ "progress": {
809
+ "type": "object",
810
+ "required": [
811
+ "done",
812
+ "failed",
813
+ "running",
814
+ "total"
815
+ ],
816
+ "properties": {
817
+ "done": {
818
+ "type": "number"
819
+ },
820
+ "failed": {
821
+ "type": "number"
822
+ },
823
+ "running": {
824
+ "type": "number"
825
+ },
826
+ "total": {
827
+ "anyOf": [
828
+ {
829
+ "type": "number"
830
+ },
831
+ {
832
+ "type": "null"
833
+ }
834
+ ]
835
+ }
836
+ }
837
+ },
838
+ "log": {
839
+ "type": "string"
840
+ }
841
+ }
842
+ },
843
+ "job.wait": {
844
+ "type": "object",
845
+ "required": [
846
+ "jobId",
847
+ "state",
848
+ "type",
849
+ "elapsedMs",
850
+ "pollCount",
851
+ "success",
852
+ "progress"
853
+ ],
854
+ "properties": {
855
+ "jobId": {
856
+ "type": "string"
857
+ },
858
+ "state": {
859
+ "type": "string"
860
+ },
861
+ "type": {
862
+ "type": "string"
863
+ },
864
+ "elapsedMs": {
865
+ "type": "number"
866
+ },
867
+ "pollCount": {
868
+ "type": "number"
869
+ },
870
+ "success": {
871
+ "type": "boolean"
872
+ },
873
+ "timedOut": {
874
+ "type": "boolean"
875
+ },
876
+ "progress": {
877
+ "type": "object",
878
+ "required": [
879
+ "done",
880
+ "failed",
881
+ "running",
882
+ "total"
883
+ ],
884
+ "properties": {
885
+ "done": {
886
+ "type": "number"
887
+ },
888
+ "failed": {
889
+ "type": "number"
890
+ },
891
+ "running": {
892
+ "type": "number"
893
+ },
894
+ "total": {
895
+ "anyOf": [
896
+ {
897
+ "type": "number"
898
+ },
899
+ {
900
+ "type": "null"
901
+ }
902
+ ]
903
+ }
904
+ }
905
+ },
906
+ "log": {
907
+ "type": "string"
908
+ }
909
+ }
910
+ },
911
+ "notebook.get-jupyter": {
912
+ "additionalProperties": true,
913
+ "type": "object",
914
+ "required": [
915
+ "metadata",
916
+ "nbformat",
917
+ "nbformat_minor",
918
+ "cells"
919
+ ],
920
+ "properties": {
921
+ "metadata": {
922
+ "type": "object",
923
+ "patternProperties": {
924
+ "^(.*)$": {}
925
+ }
926
+ },
927
+ "nbformat": {
928
+ "type": "number"
929
+ },
930
+ "nbformat_minor": {
931
+ "type": "number"
932
+ },
933
+ "cells": {
934
+ "type": "array",
935
+ "items": {
936
+ "additionalProperties": true,
937
+ "type": "object",
938
+ "required": [
939
+ "cell_type",
940
+ "source"
941
+ ],
942
+ "properties": {
943
+ "cell_type": {
944
+ "type": "string"
945
+ },
946
+ "source": {
947
+ "anyOf": [
948
+ {
949
+ "type": "string"
950
+ },
951
+ {
952
+ "type": "array",
953
+ "items": {
954
+ "type": "string"
955
+ }
956
+ }
957
+ ]
958
+ },
959
+ "metadata": {
960
+ "type": "object",
961
+ "patternProperties": {
962
+ "^(.*)$": {}
963
+ }
964
+ },
965
+ "outputs": {
966
+ "type": "array",
967
+ "items": {}
968
+ },
969
+ "execution_count": {
970
+ "anyOf": [
971
+ {
972
+ "type": "null"
973
+ },
974
+ {
975
+ "type": "number"
976
+ }
977
+ ]
978
+ }
979
+ }
980
+ }
981
+ }
982
+ }
983
+ },
984
+ "notebook.get-sql": {
985
+ "additionalProperties": true,
986
+ "type": "object",
987
+ "required": [
988
+ "connection",
989
+ "cells"
990
+ ],
991
+ "properties": {
992
+ "connection": {
993
+ "type": "string"
994
+ },
995
+ "cells": {
996
+ "type": "array",
997
+ "items": {
998
+ "additionalProperties": true,
999
+ "type": "object",
1000
+ "required": [
1001
+ "id",
1002
+ "type",
1003
+ "code"
1004
+ ],
1005
+ "properties": {
1006
+ "id": {
1007
+ "type": "string"
1008
+ },
1009
+ "type": {
1010
+ "type": "string"
1011
+ },
1012
+ "name": {
1013
+ "type": "string"
1014
+ },
1015
+ "code": {
1016
+ "type": "string"
1017
+ }
1018
+ }
1019
+ }
1020
+ }
1021
+ }
1022
+ },
1023
+ "notebook.history-sql": {
1024
+ "type": "object",
1025
+ "patternProperties": {
1026
+ "^(.*)$": {
1027
+ "type": "array",
1028
+ "items": {}
1029
+ }
1030
+ }
1031
+ },
1032
+ "notebook.list-jupyter": {
1033
+ "type": "array",
1034
+ "items": {
1035
+ "additionalProperties": true,
1036
+ "type": "object",
1037
+ "required": [
1038
+ "name",
1039
+ "projectKey",
1040
+ "language"
1041
+ ],
1042
+ "properties": {
1043
+ "name": {
1044
+ "type": "string"
1045
+ },
1046
+ "projectKey": {
1047
+ "type": "string"
1048
+ },
1049
+ "language": {
1050
+ "type": "string"
1051
+ },
1052
+ "kernelSpec": {
1053
+ "additionalProperties": true,
1054
+ "type": "object",
1055
+ "required": [
1056
+ "name"
1057
+ ],
1058
+ "properties": {
1059
+ "name": {
1060
+ "type": "string"
1061
+ },
1062
+ "display_name": {
1063
+ "type": "string"
1064
+ },
1065
+ "language": {
1066
+ "type": "string"
1067
+ }
1068
+ }
1069
+ }
1070
+ }
1071
+ }
1072
+ },
1073
+ "notebook.list-sql": {
1074
+ "type": "array",
1075
+ "items": {
1076
+ "additionalProperties": true,
1077
+ "type": "object",
1078
+ "required": [
1079
+ "id",
1080
+ "language",
1081
+ "connection"
1082
+ ],
1083
+ "properties": {
1084
+ "id": {
1085
+ "type": "string"
1086
+ },
1087
+ "projectKey": {
1088
+ "type": "string"
1089
+ },
1090
+ "language": {
1091
+ "type": "string"
1092
+ },
1093
+ "connection": {
1094
+ "type": "string"
1095
+ }
1096
+ }
1097
+ }
1098
+ },
1099
+ "notebook.save-jupyter": {
1100
+ "type": "object",
1101
+ "additionalProperties": false,
1102
+ "required": [
1103
+ "saved",
1104
+ "resource",
1105
+ "created",
1106
+ "hash"
1107
+ ],
1108
+ "properties": {
1109
+ "saved": {
1110
+ "type": "string"
1111
+ },
1112
+ "resource": {
1113
+ "enum": [
1114
+ "jupyter-notebook",
1115
+ "sql-notebook"
1116
+ ]
1117
+ },
1118
+ "created": {
1119
+ "type": "boolean"
1120
+ },
1121
+ "hash": {
1122
+ "type": "string",
1123
+ "pattern": "^[a-f0-9]{64}$"
1124
+ }
1125
+ }
1126
+ },
1127
+ "notebook.save-sql": {
1128
+ "type": "object",
1129
+ "additionalProperties": false,
1130
+ "required": [
1131
+ "saved",
1132
+ "requested",
1133
+ "resource",
1134
+ "created",
1135
+ "hash"
1136
+ ],
1137
+ "properties": {
1138
+ "saved": {
1139
+ "type": "string"
1140
+ },
1141
+ "resource": {
1142
+ "enum": [
1143
+ "jupyter-notebook",
1144
+ "sql-notebook"
1145
+ ]
1146
+ },
1147
+ "created": {
1148
+ "type": "boolean"
1149
+ },
1150
+ "hash": {
1151
+ "type": "string",
1152
+ "pattern": "^[a-f0-9]{64}$"
1153
+ },
1154
+ "requested": {
1155
+ "type": "string"
1156
+ }
1157
+ }
1158
+ },
1159
+ "notebook.sessions-jupyter": {
1160
+ "type": "array",
1161
+ "items": {
1162
+ "additionalProperties": true,
1163
+ "type": "object",
1164
+ "required": [
1165
+ "sessionId"
1166
+ ],
1167
+ "properties": {
1168
+ "sessionId": {
1169
+ "type": "string"
1170
+ },
1171
+ "kernelId": {
1172
+ "type": "string"
1173
+ },
1174
+ "projectKey": {
1175
+ "type": "string"
1176
+ },
1177
+ "notebookName": {
1178
+ "type": "string"
1179
+ },
1180
+ "sessionCreator": {
1181
+ "type": "string"
1182
+ },
1183
+ "kernelExecutionState": {
1184
+ "type": "string"
1185
+ }
1186
+ }
1187
+ }
1188
+ },
1189
+ "project-library.diff": {
1190
+ "type": "object",
1191
+ "additionalProperties": false,
1192
+ "required": [
1193
+ "path",
1194
+ "unchanged",
1195
+ "added",
1196
+ "removed",
1197
+ "diff",
1198
+ "diffTruncated",
1199
+ "localSha256",
1200
+ "localBytes",
1201
+ "maxLines"
1202
+ ],
1203
+ "properties": {
1204
+ "path": {
1205
+ "type": "string"
1206
+ },
1207
+ "unchanged": {
1208
+ "type": "boolean"
1209
+ },
1210
+ "added": {
1211
+ "type": "integer",
1212
+ "minimum": 0
1213
+ },
1214
+ "removed": {
1215
+ "type": "integer",
1216
+ "minimum": 0
1217
+ },
1218
+ "diff": {
1219
+ "type": "string"
1220
+ },
1221
+ "diffTruncated": {
1222
+ "type": "boolean"
1223
+ },
1224
+ "binary": {
1225
+ "type": "boolean"
1226
+ },
1227
+ "remoteAbsent": {
1228
+ "type": "boolean"
1229
+ },
1230
+ "remoteSha256": {
1231
+ "type": "string",
1232
+ "pattern": "^[a-f0-9]{64}$"
1233
+ },
1234
+ "remoteBytes": {
1235
+ "type": "integer",
1236
+ "minimum": 0
1237
+ },
1238
+ "localSha256": {
1239
+ "type": "string",
1240
+ "pattern": "^[a-f0-9]{64}$"
1241
+ },
1242
+ "localBytes": {
1243
+ "type": "integer",
1244
+ "minimum": 0
1245
+ },
1246
+ "maxLines": {
1247
+ "type": "integer",
1248
+ "minimum": 0
1249
+ }
1250
+ }
1251
+ },
1252
+ "project-library.get-bytes": {
1253
+ "type": "object",
1254
+ "additionalProperties": false,
1255
+ "required": [
1256
+ "path",
1257
+ "bytes",
1258
+ "sha256"
1259
+ ],
1260
+ "properties": {
1261
+ "path": {
1262
+ "type": "string"
1263
+ },
1264
+ "bytes": {
1265
+ "type": "integer",
1266
+ "minimum": 0
1267
+ },
1268
+ "sha256": {
1269
+ "type": "string",
1270
+ "pattern": "^[a-f0-9]{64}$"
1271
+ }
1272
+ }
1273
+ },
1274
+ "project-library.list": {
1275
+ "type": "array",
1276
+ "items": {
1277
+ "type": "object",
1278
+ "additionalProperties": false,
1279
+ "required": [
1280
+ "name"
1281
+ ],
1282
+ "properties": {
1283
+ "name": {
1284
+ "type": "string"
1285
+ },
1286
+ "path": {
1287
+ "type": "string"
1288
+ },
1289
+ "size": {
1290
+ "type": "integer",
1291
+ "minimum": 0
1292
+ },
1293
+ "mimeType": {
1294
+ "type": "string"
1295
+ },
1296
+ "hasData": {
1297
+ "type": "boolean"
1298
+ },
1299
+ "lastModified": {
1300
+ "type": "number"
1301
+ },
1302
+ "children": {
1303
+ "type": "array",
1304
+ "items": {
1305
+ "type": "object",
1306
+ "additionalProperties": true
1307
+ }
1308
+ }
1309
+ }
1310
+ }
1311
+ },
1312
+ "project-library.put": {
1313
+ "type": "object",
1314
+ "additionalProperties": false,
1315
+ "required": [
1316
+ "updated",
1317
+ "bytes",
1318
+ "sha256"
1319
+ ],
1320
+ "properties": {
1321
+ "updated": {
1322
+ "type": "string"
1323
+ },
1324
+ "bytes": {
1325
+ "type": "integer",
1326
+ "minimum": 0
1327
+ },
1328
+ "sha256": {
1329
+ "type": "string",
1330
+ "pattern": "^[a-f0-9]{64}$"
1331
+ },
1332
+ "beforeSha256": {
1333
+ "type": "string",
1334
+ "pattern": "^[a-f0-9]{64}$"
1335
+ }
1336
+ }
1337
+ },
1338
+ "project.get": {
1339
+ "additionalProperties": true,
1340
+ "type": "object",
1341
+ "required": [
1342
+ "projectKey",
1343
+ "name"
1344
+ ],
1345
+ "properties": {
1346
+ "projectKey": {
1347
+ "type": "string"
1348
+ },
1349
+ "name": {
1350
+ "type": "string"
1351
+ },
1352
+ "shortDesc": {
1353
+ "type": "string"
1354
+ },
1355
+ "projectStatus": {
1356
+ "type": "string"
1357
+ },
1358
+ "projectAppType": {
1359
+ "type": "string"
1360
+ },
1361
+ "creationTag": {
1362
+ "additionalProperties": true,
1363
+ "type": "object",
1364
+ "properties": {
1365
+ "versionNumber": {
1366
+ "type": "number"
1367
+ },
1368
+ "lastModifiedOn": {
1369
+ "anyOf": [
1370
+ {
1371
+ "type": "number"
1372
+ },
1373
+ {
1374
+ "type": "string"
1375
+ }
1376
+ ]
1377
+ }
1378
+ }
1379
+ },
1380
+ "ownerLogin": {
1381
+ "type": "string"
1382
+ },
1383
+ "tags": {
1384
+ "type": "array",
1385
+ "items": {
1386
+ "type": "string"
1387
+ }
1388
+ },
1389
+ "versionTag": {
1390
+ "additionalProperties": true,
1391
+ "type": "object",
1392
+ "required": [
1393
+ "versionNumber",
1394
+ "lastModifiedOn"
1395
+ ],
1396
+ "properties": {
1397
+ "versionNumber": {
1398
+ "type": "number"
1399
+ },
1400
+ "lastModifiedOn": {
1401
+ "type": "number"
1402
+ }
1403
+ }
1404
+ }
1405
+ }
1406
+ },
1407
+ "project.list": {
1408
+ "type": "array",
1409
+ "items": {
1410
+ "additionalProperties": true,
1411
+ "type": "object",
1412
+ "required": [
1413
+ "projectKey",
1414
+ "name"
1415
+ ],
1416
+ "properties": {
1417
+ "projectKey": {
1418
+ "type": "string"
1419
+ },
1420
+ "name": {
1421
+ "type": "string"
1422
+ },
1423
+ "shortDesc": {
1424
+ "type": "string"
1425
+ }
1426
+ }
1427
+ }
1428
+ },
1429
+ "project.metadata": {
1430
+ "additionalProperties": true,
1431
+ "type": "object",
1432
+ "properties": {
1433
+ "label": {
1434
+ "type": "string"
1435
+ },
1436
+ "shortDesc": {
1437
+ "type": "string"
1438
+ },
1439
+ "description": {
1440
+ "type": "string"
1441
+ },
1442
+ "tags": {
1443
+ "type": "array",
1444
+ "items": {
1445
+ "type": "string"
1446
+ }
1447
+ },
1448
+ "customFields": {
1449
+ "type": "object",
1450
+ "patternProperties": {
1451
+ "^(.*)$": {}
1452
+ }
1453
+ },
1454
+ "checklists": {
1455
+ "additionalProperties": true,
1456
+ "type": "object",
1457
+ "properties": {
1458
+ "checklists": {
1459
+ "type": "array",
1460
+ "items": {
1461
+ "additionalProperties": true,
1462
+ "type": "object",
1463
+ "required": [
1464
+ "title"
1465
+ ],
1466
+ "properties": {
1467
+ "title": {
1468
+ "type": "string"
1469
+ },
1470
+ "items": {
1471
+ "type": "array",
1472
+ "items": {
1473
+ "additionalProperties": true,
1474
+ "type": "object",
1475
+ "required": [
1476
+ "done"
1477
+ ],
1478
+ "properties": {
1479
+ "done": {
1480
+ "type": "boolean"
1481
+ }
1482
+ }
1483
+ }
1484
+ }
1485
+ }
1486
+ }
1487
+ }
1488
+ }
1489
+ }
1490
+ }
1491
+ },
1492
+ "recipe.list": {
1493
+ "type": "array",
1494
+ "items": {
1495
+ "additionalProperties": true,
1496
+ "type": "object",
1497
+ "required": [
1498
+ "name"
1499
+ ],
1500
+ "properties": {
1501
+ "name": {
1502
+ "type": "string"
1503
+ },
1504
+ "type": {
1505
+ "type": "string"
1506
+ }
1507
+ }
1508
+ }
1509
+ },
1510
+ "scenario.get": {
1511
+ "additionalProperties": true,
1512
+ "type": "object",
1513
+ "required": [
1514
+ "id"
1515
+ ],
1516
+ "properties": {
1517
+ "id": {
1518
+ "type": "string"
1519
+ },
1520
+ "name": {
1521
+ "type": "string"
1522
+ },
1523
+ "active": {
1524
+ "type": "boolean"
1525
+ },
1526
+ "type": {
1527
+ "type": "string"
1528
+ },
1529
+ "projectKey": {
1530
+ "type": "string"
1531
+ },
1532
+ "params": {
1533
+ "additionalProperties": true,
1534
+ "type": "object",
1535
+ "properties": {
1536
+ "steps": {
1537
+ "type": "array",
1538
+ "items": {}
1539
+ },
1540
+ "triggers": {
1541
+ "type": "array",
1542
+ "items": {}
1543
+ },
1544
+ "reporters": {
1545
+ "type": "array",
1546
+ "items": {}
1547
+ },
1548
+ "customScript": {
1549
+ "additionalProperties": true,
1550
+ "type": "object",
1551
+ "properties": {
1552
+ "script": {
1553
+ "type": "string"
1554
+ }
1555
+ }
1556
+ }
1557
+ }
1558
+ },
1559
+ "versionTag": {
1560
+ "additionalProperties": true,
1561
+ "type": "object",
1562
+ "required": [
1563
+ "versionNumber"
1564
+ ],
1565
+ "properties": {
1566
+ "versionNumber": {
1567
+ "type": "number"
1568
+ }
1569
+ }
1570
+ }
1571
+ }
1572
+ },
1573
+ "scenario.list": {
1574
+ "type": "array",
1575
+ "items": {
1576
+ "additionalProperties": true,
1577
+ "type": "object",
1578
+ "required": [
1579
+ "id"
1580
+ ],
1581
+ "properties": {
1582
+ "id": {
1583
+ "type": "string"
1584
+ },
1585
+ "name": {
1586
+ "type": "string"
1587
+ },
1588
+ "active": {
1589
+ "type": "boolean"
1590
+ }
1591
+ }
1592
+ }
1593
+ },
1594
+ "scenario.status": {
1595
+ "additionalProperties": true,
1596
+ "type": "object",
1597
+ "properties": {
1598
+ "id": {
1599
+ "type": "string"
1600
+ },
1601
+ "name": {
1602
+ "type": "string"
1603
+ },
1604
+ "active": {
1605
+ "type": "boolean"
1606
+ },
1607
+ "running": {
1608
+ "type": "boolean"
1609
+ },
1610
+ "nextRun": {
1611
+ "type": "number"
1612
+ },
1613
+ "lastRun": {
1614
+ "additionalProperties": true,
1615
+ "type": "object",
1616
+ "properties": {
1617
+ "runId": {
1618
+ "type": "string"
1619
+ },
1620
+ "outcome": {
1621
+ "type": "string"
1622
+ },
1623
+ "start": {
1624
+ "type": "number"
1625
+ },
1626
+ "end": {
1627
+ "type": "number"
1628
+ },
1629
+ "trigger": {
1630
+ "additionalProperties": true,
1631
+ "type": "object",
1632
+ "properties": {
1633
+ "type": {
1634
+ "type": "string"
1635
+ }
1636
+ }
1637
+ }
1638
+ }
1639
+ }
1640
+ }
1641
+ },
1642
+ "sql.query": {
1643
+ "anyOf": [
1644
+ {
1645
+ "type": "object",
1646
+ "required": [
1647
+ "queryId",
1648
+ "schema",
1649
+ "rows"
1650
+ ],
1651
+ "properties": {
1652
+ "queryId": {
1653
+ "type": "string"
1654
+ },
1655
+ "schema": {
1656
+ "type": "array",
1657
+ "items": {
1658
+ "additionalProperties": true,
1659
+ "type": "object",
1660
+ "required": [
1661
+ "name",
1662
+ "type"
1663
+ ],
1664
+ "properties": {
1665
+ "name": {
1666
+ "type": "string"
1667
+ },
1668
+ "type": {
1669
+ "type": "string"
1670
+ }
1671
+ }
1672
+ }
1673
+ },
1674
+ "columns": {
1675
+ "type": "array",
1676
+ "items": {
1677
+ "additionalProperties": true,
1678
+ "type": "object",
1679
+ "required": [
1680
+ "name",
1681
+ "type"
1682
+ ],
1683
+ "properties": {
1684
+ "name": {
1685
+ "type": "string"
1686
+ },
1687
+ "type": {
1688
+ "type": "string"
1689
+ }
1690
+ }
1691
+ }
1692
+ },
1693
+ "rows": {
1694
+ "type": "array",
1695
+ "items": {
1696
+ "type": "array",
1697
+ "items": {}
1698
+ }
1699
+ }
1700
+ }
1701
+ },
1702
+ {
1703
+ "type": "object",
1704
+ "required": [
1705
+ "queryId",
1706
+ "rowCount",
1707
+ "preview"
1708
+ ],
1709
+ "additionalProperties": true,
1710
+ "properties": {
1711
+ "queryId": {
1712
+ "type": "string"
1713
+ },
1714
+ "rowCount": {
1715
+ "type": "number"
1716
+ },
1717
+ "preview": {
1718
+ "type": "array",
1719
+ "items": true
1720
+ },
1721
+ "truncated": {
1722
+ "type": "boolean"
1723
+ },
1724
+ "outputPath": {
1725
+ "type": "string"
1726
+ },
1727
+ "written": {
1728
+ "type": "string"
1729
+ }
1730
+ }
1731
+ }
1732
+ ]
1733
+ }
1734
+ }
1735
+ }