@elyra/pipeline-schemas 3.0.90 → 3.0.92

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 (8) hide show
  1. package/common-canvas/canvas-info/canvas-info-v3-schema.json +27 -58
  2. package/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json +59 -49
  3. package/common-pipeline/pipeline-flow/pipeline-flow-v3-schema.json +18 -19
  4. package/package.json +1 -1
  5. package/types/canvas-info-v3.ts +50 -52
  6. package/types/index.d.ts +52 -3
  7. package/types/palette-v3.ts +32 -38
  8. package/types/pipeline-flow-v3.ts +62 -57
package/common-canvas/canvas-info/canvas-info-v3-schema.json CHANGED
@@ -157,37 +157,9 @@
157
157
  "additionalProperties": true
158
158
  },
159
159
  "zoom": {
160
- "oneOf": [
161
- {
162
- "description": "Deprecated - use zoom object instead. Scale factor as a percentage. 100% is standard scale amount. Smaller values zoom out. Larger values zoom in.",
163
- "type": "integer",
164
- "deprecated": true
165
- },
166
- {
167
- "description": "A zoom object containing translation and scale amounts.",
168
- "type": "object",
169
- "properties": {
170
- "x": {
171
- "description": "Horizontal translation amount. Positive value moves right, negative to the left.",
172
- "type": "number"
173
- },
174
- "y": {
175
- "description": "Vertical translation amount. Positive value moves down, negative moves up.",
176
- "type": "number"
177
- },
178
- "k": {
179
- "description": "Scale amount. 1.0 is the standard scale amount. Smaller values zoom out. Larger values zoom in.",
180
- "type": "number"
181
- }
182
- },
183
- "required": [
184
- "x",
185
- "y",
186
- "k"
187
- ],
188
- "additionalProperties": false
189
- }
190
- ]
160
+ "description": "X/Y pan and scale amounts for the canvas.",
161
+ "type": "object",
162
+ "$ref": "./pipeline-flow-ui-v3-schema.json#/definitions/zoom_object_def"
191
163
  },
192
164
  "app_data": {
193
165
  "description": "Object containing app-specific data",
@@ -255,15 +227,15 @@
255
227
  "description": "y-position of this canvas execution node.",
256
228
  "type": "number"
257
229
  },
258
- "is_resized": {
230
+ "isResized": {
259
231
  "description": "Indicates whether a node has been resized or not. If true, resize_width and resize_height are used for node display. If false, the default width and height are used.",
260
232
  "type": "boolean"
261
233
  },
262
- "resize_height": {
234
+ "resizeHeight": {
263
235
  "description": "Height of resized node. The node will be displayed with this height, when is_resized is true, in preference to its default height.",
264
236
  "type": "number"
265
237
  },
266
- "resize_width": {
238
+ "resizeWidth": {
267
239
  "description": "Width of resized node. The node will be displayed with this width, when is_resized is true, in preference to its default width.",
268
240
  "type": "number"
269
241
  },
@@ -306,7 +278,10 @@
306
278
  "type": "object",
307
279
  "additionalProperties": true
308
280
  }
309
- }
281
+ },
282
+ "required": [
283
+ "id"
284
+ ]
310
285
  },
311
286
  "canvas_execution_node": {
312
287
  "allOf": [
@@ -348,7 +323,6 @@
348
323
  }
349
324
  },
350
325
  "required": [
351
- "id",
352
326
  "type",
353
327
  "op"
354
328
  ],
@@ -428,7 +402,6 @@
428
402
  }
429
403
  },
430
404
  "required": [
431
- "id",
432
405
  "type",
433
406
  "subflow_ref"
434
407
  ],
@@ -476,7 +449,6 @@
476
449
  }
477
450
  },
478
451
  "required": [
479
- "id",
480
452
  "type",
481
453
  "outputs"
482
454
  ],
@@ -501,7 +473,6 @@
501
473
  "$ref": "#/definitions/canvas_ports"
502
474
  },
503
475
  "outputs": {
504
- "description": "An optional set of output ports, typically used for directing error information out of the binding node.",
505
476
  "$ref": "#/definitions/canvas_ports"
506
477
  },
507
478
  "app_data": {
@@ -527,7 +498,6 @@
527
498
  }
528
499
  },
529
500
  "required": [
530
- "id",
531
501
  "type",
532
502
  "inputs"
533
503
  ],
@@ -574,7 +544,6 @@
574
544
  }
575
545
  },
576
546
  "required": [
577
- "id",
578
547
  "type",
579
548
  "inputs"
580
549
  ],
@@ -750,8 +719,8 @@
750
719
  "description": "CSS class(es) to apply to the comment",
751
720
  "type": "string"
752
721
  },
753
- "content_type": {
754
- "description": "Type of content",
722
+ "contentType": {
723
+ "description": "The type of content either regular or markdown or WYSIWYG",
755
724
  "type": "string"
756
725
  },
757
726
  "formats": {
@@ -815,11 +784,11 @@
815
784
  "commentLink"
816
785
  ]
817
786
  },
818
- "src_node_id": {
787
+ "srcNodeId": {
819
788
  "description": "ID of the comment this link connects from.",
820
789
  "type": "string"
821
790
  },
822
- "trg_node_id": {
791
+ "trgNodeId": {
823
792
  "description": "ID of the node this link connects to.",
824
793
  "type": "string"
825
794
  },
@@ -842,7 +811,7 @@
842
811
  }
843
812
  },
844
813
  "required": [
845
- "node_ref"
814
+ "id"
846
815
  ],
847
816
  "additionalProperties": true
848
817
  },
@@ -860,35 +829,35 @@
860
829
  "nodeLink"
861
830
  ]
862
831
  },
863
- "src_node_id": {
832
+ "srcNodeId": {
864
833
  "description": "ID of the source node this link connects from.",
865
834
  "type": "string"
866
835
  },
867
- "src_node_port_id": {
836
+ "srcNodePortId": {
868
837
  "description": "Optional ID of the port on the source node this link connects from. Defaults to the first port if omitted.",
869
838
  "type": "string"
870
839
  },
871
- "trg_node_id": {
840
+ "trgNodeId": {
872
841
  "description": "ID of the target node this link connects to.",
873
842
  "type": "string"
874
843
  },
875
- "trg_node_port_id": {
844
+ "trgNodePortId": {
876
845
  "description": "Optional ID of the port on the target node this link connects from. Defaults to the first port if omitted.",
877
846
  "type": "string"
878
847
  },
879
- "src_pos": {
848
+ "srcPos": {
880
849
  "x_pos": "number",
881
850
  "y_pos": "number"
882
851
  },
883
- "trg_pos": {
852
+ "trgPos": {
884
853
  "x_pos": "number",
885
854
  "y_pos": "number"
886
855
  },
887
- "link_name": {
856
+ "linkName": {
888
857
  "description": "optional link name (used in parameter sets when there are multiple input sources)",
889
858
  "type": "string"
890
859
  },
891
- "type_attr": {
860
+ "typeAttr": {
892
861
  "description": "Optional type attribute for the link. This can store optional atribute info.",
893
862
  "type": "string"
894
863
  },
@@ -920,7 +889,7 @@
920
889
  }
921
890
  },
922
891
  "required": [
923
- "node_id_ref"
892
+ "id"
924
893
  ],
925
894
  "additionalProperties": false
926
895
  },
@@ -938,11 +907,11 @@
938
907
  "associationLink"
939
908
  ]
940
909
  },
941
- "src_node_id": {
910
+ "srcNodeId": {
942
911
  "description": "ID of the source node of the association.",
943
912
  "type": "string"
944
913
  },
945
- "trg_node_id": {
914
+ "trgNodeId": {
946
915
  "description": "ID of the target node of the association.",
947
916
  "type": "string"
948
917
  },
@@ -966,7 +935,7 @@
966
935
  }
967
936
  },
968
937
  "required": [
969
- "node_id_ref"
938
+ "id"
970
939
  ],
971
940
  "additionalProperties": false
972
941
  }
package/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json CHANGED
@@ -7,7 +7,7 @@
7
7
  "additionalProperties": true,
8
8
  "definitions": {
9
9
  "pipeline_flow_ui_def": {
10
- "description": "Top level UI information",
10
+ "description": "Pipeline flow UI properties.",
11
11
  "type": "object",
12
12
  "properties": {
13
13
  "name": {
@@ -26,7 +26,7 @@
26
26
  "additionalProperties": true
27
27
  },
28
28
  "pipeline_ui_def": {
29
- "description": "Pipeline level UI information",
29
+ "description": "Pipeline UI properties",
30
30
  "type": "object",
31
31
  "properties": {
32
32
  "description": {
@@ -34,37 +34,9 @@
34
34
  "type": "string"
35
35
  },
36
36
  "zoom": {
37
- "oneOf": [
38
- {
39
- "description": "Deprecated - use zoom object instead. Scale factor as a percentage. 100% is standard scale amount. Smaller values zoom out. Larger values zoom in.",
40
- "type": "integer",
41
- "deprecated": true
42
- },
43
- {
44
- "description": "A zoom object containing translation and scale amounts.",
45
- "type": "object",
46
- "properties": {
47
- "x": {
48
- "description": "Horizontal translation amount. Positive value moves right, negative to the left.",
49
- "type": "number"
50
- },
51
- "y": {
52
- "description": "Vertical translation amount. Positive value moves down, negative moves up.",
53
- "type": "number"
54
- },
55
- "k": {
56
- "description": "Scale amount. 1.0 is the standard scale amount. Smaller values zoom out. Larger values zoom in.",
57
- "type": "number"
58
- }
59
- },
60
- "required": [
61
- "x",
62
- "y",
63
- "k"
64
- ],
65
- "additionalProperties": false
66
- }
67
- ]
37
+ "description": "X/Y pan and scale amounts for the canvas.",
38
+ "type": "object",
39
+ "$ref": "#/definitions/zoom_object_def"
68
40
  },
69
41
  "comments": {
70
42
  "description": "Array of Comments, optionally associated with nodes",
@@ -78,8 +50,41 @@
78
50
  },
79
51
  "additionalProperties": true
80
52
  },
81
- "port_info_def": {
82
- "description": "Additional UI info for ports",
53
+ "zoom_object_def": {
54
+ "oneOf": [
55
+ {
56
+ "description": "Deprecated - use zoom object instead. Scale factor as a percentage. 100% is standard scale amount. Smaller values zoom out. Larger values zoom in.",
57
+ "type": "integer",
58
+ "deprecated": true
59
+ },
60
+ {
61
+ "description": "A zoom object containing translation and scale amounts.",
62
+ "type": "object",
63
+ "properties": {
64
+ "x": {
65
+ "description": "Horizontal translation amount. Positive value moves right, negative to the left.",
66
+ "type": "number"
67
+ },
68
+ "y": {
69
+ "description": "Vertical translation amount. Positive value moves down, negative moves up.",
70
+ "type": "number"
71
+ },
72
+ "k": {
73
+ "description": "Scale amount. 1.0 is the standard scale amount. Smaller values zoom out. Larger values zoom in.",
74
+ "type": "number"
75
+ }
76
+ },
77
+ "required": [
78
+ "x",
79
+ "y",
80
+ "k"
81
+ ],
82
+ "additionalProperties": false
83
+ }
84
+ ]
85
+ },
86
+ "port_ui_def": {
87
+ "description": "Port UI properties ",
83
88
  "type": "object",
84
89
  "properties": {
85
90
  "cardinality": {
@@ -113,8 +118,8 @@
113
118
  },
114
119
  "additionalProperties": true
115
120
  },
116
- "node_info_def": {
117
- "description": "object with app-specific UI-information",
121
+ "node_ui_def": {
122
+ "description": "Node UI properties.",
118
123
  "type": "object",
119
124
  "properties": {
120
125
  "label": {
@@ -184,7 +189,7 @@
184
189
  "type": "array",
185
190
  "minItems": 0,
186
191
  "items": {
187
- "$ref": "#/definitions/association_def"
192
+ "$ref": "#/definitions/association_link_def"
188
193
  }
189
194
  },
190
195
  "messages": {
@@ -226,8 +231,8 @@
226
231
  },
227
232
  "additionalProperties": true
228
233
  },
229
- "node_link_info_def": {
230
- "description": "object with app-specific UI-information",
234
+ "node_link_ui_def": {
235
+ "description": "Node link UI properties.",
231
236
  "type": "object",
232
237
  "properties": {
233
238
  "description": {
@@ -254,14 +259,14 @@
254
259
  },
255
260
  "additionalProperties": true
256
261
  },
257
- "runtime_info_def": {
258
- "description": "Runtime information",
262
+ "runtime_ui_def": {
263
+ "description": "Runtime UI properties.",
259
264
  "type": "object",
260
265
  "properties": {},
261
266
  "additionalProperties": true
262
267
  },
263
- "association_def": {
264
- "description": "Non-data link",
268
+ "association_link_def": {
269
+ "description": "Association link properties",
265
270
  "type": "object",
266
271
  "properties": {
267
272
  "id": {
@@ -386,7 +391,7 @@
386
391
  }
387
392
  }
388
393
  },
389
- { "$ref": "#/definitions/shared_decoration_def" }
394
+ { "$ref": "#/definitions/decoration_shared_properties" }
390
395
  ]
391
396
  },
392
397
  "label_decoration_def": {
@@ -424,7 +429,7 @@
424
429
  }
425
430
  }
426
431
  },
427
- { "$ref": "#/definitions/shared_decoration_def" }
432
+ { "$ref": "#/definitions/decoration_shared_properties" }
428
433
  ]
429
434
  },
430
435
  "shape_decoration_def": {
@@ -439,7 +444,7 @@
439
444
  }
440
445
  }
441
446
  },
442
- { "$ref": "#/definitions/shared_decoration_def" }
447
+ { "$ref": "#/definitions/decoration_shared_properties" }
443
448
  ]
444
449
  },
445
450
  "jsx_decoration_def": {
@@ -454,10 +459,10 @@
454
459
  }
455
460
  }
456
461
  },
457
- { "$ref": "#/definitions/shared_decoration_def" }
462
+ { "$ref": "#/definitions/decoration_shared_properties" }
458
463
  ]
459
464
  },
460
- "shared_decoration_def": {
465
+ "decoration_shared_properties": {
461
466
  "description": "Shared properties across all types of decoration.",
462
467
  "type": "object",
463
468
  "properties": {
@@ -535,6 +540,7 @@
535
540
  ]
536
541
  },
537
542
  "comment_def": {
543
+ "description": "Comment definition",
538
544
  "type": "object",
539
545
  "properties": {
540
546
  "id": {
@@ -575,6 +581,10 @@
575
581
  "description": "Comment content",
576
582
  "type": "string"
577
583
  },
584
+ "content_type": {
585
+ "description": "The type of content either regular or markdown or WYSIWYG",
586
+ "type": "string"
587
+ },
578
588
  "associated_id_refs": {
579
589
  "description": "Optional array of associated node id references",
580
590
  "type": "array",
package/common-pipeline/pipeline-flow/pipeline-flow-v3-schema.json CHANGED
@@ -176,7 +176,7 @@
176
176
  "type": "string"
177
177
  },
178
178
  "description": {
179
- "description": "Deprecated - use description in pipeline-flow-ui-v3-schema.json#/definitions/node_info_def instead.",
179
+ "description": "Deprecated - use description in pipeline-flow-ui-v3-schema.json#/definitions/node_ui_def instead.",
180
180
  "type": "string",
181
181
  "deprecated": true
182
182
  },
@@ -211,7 +211,7 @@
211
211
  "type": "object",
212
212
  "properties": {
213
213
  "ui_data": {
214
- "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/node_info_def"
214
+ "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/node_ui_def"
215
215
  }
216
216
  },
217
217
  "additionalProperties": true
@@ -233,7 +233,7 @@
233
233
  "type": "string"
234
234
  },
235
235
  "description": {
236
- "description": "Deprecated - use description in pipeline-flow-ui-v3-schema.json#/definitions/node_info_def instead.",
236
+ "description": "Deprecated - use description in pipeline-flow-ui-v3-schema.json#/definitions/node_ui_def instead.",
237
237
  "type": "string",
238
238
  "deprecated": true
239
239
  },
@@ -281,7 +281,7 @@
281
281
  "type": "object",
282
282
  "properties": {
283
283
  "ui_data": {
284
- "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/node_info_def"
284
+ "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/node_ui_def"
285
285
  }
286
286
  },
287
287
  "additionalProperties": true
@@ -303,7 +303,7 @@
303
303
  "type": "string"
304
304
  },
305
305
  "description": {
306
- "description": "Deprecated - use description in pipeline-flow-ui-v3-schema.json#/definitions/node_info_def instead.",
306
+ "description": "Deprecated - use description in pipeline-flow-ui-v3-schema.json#/definitions/node_ui_def instead.",
307
307
  "type": "string",
308
308
  "deprecated": true
309
309
  },
@@ -321,7 +321,7 @@
321
321
  "type": "object",
322
322
  "properties": {
323
323
  "ui_data": {
324
- "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/node_info_def"
324
+ "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/node_ui_def"
325
325
  }
326
326
  },
327
327
  "additionalProperties": true
@@ -359,7 +359,7 @@
359
359
  "type": "string"
360
360
  },
361
361
  "description": {
362
- "description": "Deprecated - use description in pipeline-flow-ui-v3-schema.json#/definitions/node_info_def instead.",
362
+ "description": "Deprecated - use description in pipeline-flow-ui-v3-schema.json#/definitions/node_ui_def instead.",
363
363
  "type": "string",
364
364
  "deprecated": true
365
365
  },
@@ -373,7 +373,6 @@
373
373
  "$ref": "#/definitions/ports_def"
374
374
  },
375
375
  "outputs": {
376
- "description": "An optional set of output ports, typically used for directing error information out of the binding node.",
377
376
  "$ref": "#/definitions/ports_def"
378
377
  },
379
378
  "app_data": {
@@ -381,7 +380,7 @@
381
380
  "type": "object",
382
381
  "properties": {
383
382
  "ui_data": {
384
- "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/node_info_def"
383
+ "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/node_ui_def"
385
384
  }
386
385
  },
387
386
  "additionalProperties": true
@@ -419,7 +418,7 @@
419
418
  "type": "string"
420
419
  },
421
420
  "description": {
422
- "description": "Deprecated - use description in pipeline-flow-ui-v3-schema.json#/definitions/node_info_def instead.",
421
+ "description": "Deprecated - use description in pipeline-flow-ui-v3-schema.json#/definitions/node_ui_def instead.",
423
422
  "type": "string",
424
423
  "deprecated": true
425
424
  },
@@ -458,7 +457,7 @@
458
457
  "type": "object",
459
458
  "properties": {
460
459
  "ui_data": {
461
- "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/node_info_def"
460
+ "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/node_ui_def"
462
461
  }
463
462
  },
464
463
  "additionalProperties": true
@@ -488,7 +487,7 @@
488
487
  "type": "array",
489
488
  "minItems": 0,
490
489
  "items": {
491
- "$ref": "#/definitions/link_def"
490
+ "$ref": "#/definitions/node_link_def"
492
491
  },
493
492
  "uniqueItems": true
494
493
  },
@@ -503,7 +502,7 @@
503
502
  "type": "object",
504
503
  "properties": {
505
504
  "ui_data": {
506
- "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/port_info_def"
505
+ "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/port_ui_def"
507
506
  }
508
507
  },
509
508
  "additionalProperties": true
@@ -547,7 +546,7 @@
547
546
  "type": "array",
548
547
  "minItems": 1,
549
548
  "items": {
550
- "$ref": "#/definitions/link_def"
549
+ "$ref": "#/definitions/node_link_def"
551
550
  },
552
551
  "uniqueItems": true
553
552
  },
@@ -566,7 +565,7 @@
566
565
  "type": "object",
567
566
  "properties": {
568
567
  "ui_data": {
569
- "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/port_info_def"
568
+ "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/port_ui_def"
570
569
  }
571
570
  },
572
571
  "additionalProperties": true
@@ -577,7 +576,7 @@
577
576
  ],
578
577
  "additionalProperties": false
579
578
  },
580
- "link_def": {
579
+ "node_link_def": {
581
580
  "description": "Node link definition",
582
581
  "type": "object",
583
582
  "properties": {
@@ -602,7 +601,7 @@
602
601
  "type": "string"
603
602
  },
604
603
  "description": {
605
- "description": "Deprecated - use description in pipeline-flow-ui-v3-schema.json#/definitions/node_link_info_def instead.",
604
+ "description": "Deprecated - use description in pipeline-flow-ui-v3-schema.json#/definitions/node_link_ui_def instead.",
606
605
  "type": "string",
607
606
  "deprecated": true
608
607
  },
@@ -611,7 +610,7 @@
611
610
  "type": "object",
612
611
  "properties": {
613
612
  "ui_data": {
614
- "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/node_link_info_def"
613
+ "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/node_link_ui_def"
615
614
  }
616
615
  },
617
616
  "additionalProperties": true
@@ -643,7 +642,7 @@
643
642
  "type": "object",
644
643
  "properties": {
645
644
  "ui_data": {
646
- "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/runtime_info_def"
645
+ "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/runtime_ui_def"
647
646
  }
648
647
  },
649
648
  "additionalProperties": true
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@elyra/pipeline-schemas",
3
- "version": "3.0.90",
3
+ "version": "3.0.92",
4
4
  "description": "pipeline-schemas",
5
5
  "main": "common-pipeline/pipeline-flow/upgrade/upgrade-flow.js",
6
6
  "homepage": "https://github.com/elyra-ai/pipeline-schemas",