@elyra/pipeline-schemas 3.0.78 → 3.0.80
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.
- package/common-canvas/canvas-info/canvas-info-v3-schema.json +974 -0
- package/common-pipeline/pipeline-connection/pipeline-connection-v3-schema.json +1 -3
- package/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json +180 -27
- package/common-pipeline/pipeline-flow/pipeline-flow-v3-schema.json +4 -3
- package/package.json +4 -2
|
@@ -0,0 +1,974 @@
|
|
|
1
|
+
|
|
2
|
+
{
|
|
3
|
+
"$schema": "https://json-schema.org/draft-04/schema#",
|
|
4
|
+
"description": "Canvas Info Flow Schema - for internal Common Canvas use.",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"id": "https://api.dataplatform.ibm.com/schemas/common-canvas/canvas-info/canvas-info-v3-schema.json",
|
|
7
|
+
"properties": {
|
|
8
|
+
"doc_type": {
|
|
9
|
+
"description": "Document type",
|
|
10
|
+
"type": "string"
|
|
11
|
+
},
|
|
12
|
+
"version": {
|
|
13
|
+
"description": "Canvas info flow schema version",
|
|
14
|
+
"enum": [
|
|
15
|
+
"3.0"
|
|
16
|
+
]
|
|
17
|
+
},
|
|
18
|
+
"json_schema": {
|
|
19
|
+
"description": "Refers to the JSON schema used to validate documents of this type",
|
|
20
|
+
"enum": [
|
|
21
|
+
"http://api.dataplatform.ibm.com/schemas/common-canvas/canvas-info/canvas-info-v3-schema.json",
|
|
22
|
+
"https://api.dataplatform.ibm.com/schemas/common-canvas/canvas-info/canvas-info-v3-schema.json"
|
|
23
|
+
]
|
|
24
|
+
},
|
|
25
|
+
"open_with_tool": {
|
|
26
|
+
"description": "Preferred authoring application",
|
|
27
|
+
"type": "string"
|
|
28
|
+
},
|
|
29
|
+
"id": {
|
|
30
|
+
"description": "Document identifier, GUID recommended",
|
|
31
|
+
"type": "string"
|
|
32
|
+
},
|
|
33
|
+
"name": {
|
|
34
|
+
"description": "User-defined name",
|
|
35
|
+
"type": "string"
|
|
36
|
+
},
|
|
37
|
+
"description": {
|
|
38
|
+
"description": "User-defined description",
|
|
39
|
+
"type": "string"
|
|
40
|
+
},
|
|
41
|
+
"class_name": {
|
|
42
|
+
"description": "CSS class name",
|
|
43
|
+
"type": "string"
|
|
44
|
+
},
|
|
45
|
+
"parameters": {
|
|
46
|
+
"description": "Parameters for the flow document",
|
|
47
|
+
"type": "object",
|
|
48
|
+
"properties": {},
|
|
49
|
+
"additionalProperties": true
|
|
50
|
+
},
|
|
51
|
+
"primary_pipeline": {
|
|
52
|
+
"description": "Reference to the primary (main) pipeline flow within the document",
|
|
53
|
+
"type": "string"
|
|
54
|
+
},
|
|
55
|
+
"pipelines": {
|
|
56
|
+
"description": "Array of pipelines",
|
|
57
|
+
"type": "array",
|
|
58
|
+
"minItems": 1,
|
|
59
|
+
"items": {
|
|
60
|
+
"$ref": "#/definitions/canvas_pipeline"
|
|
61
|
+
},
|
|
62
|
+
"uniqueItems": true
|
|
63
|
+
},
|
|
64
|
+
"schemas": {
|
|
65
|
+
"description": "Array of data record schemas used in the document",
|
|
66
|
+
"type": "array",
|
|
67
|
+
"minItems": 0,
|
|
68
|
+
"items": {
|
|
69
|
+
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v3-schema.json#/definitions/record_schema"
|
|
70
|
+
},
|
|
71
|
+
"uniqueItems": true
|
|
72
|
+
},
|
|
73
|
+
"runtimes": {
|
|
74
|
+
"description": "Array of runtime objects referred to in the document",
|
|
75
|
+
"type": "array",
|
|
76
|
+
"minItems": 0,
|
|
77
|
+
"items": {
|
|
78
|
+
"$ref": "./pipeline-flow-v3-schema.json#/definitions/runtime_def"
|
|
79
|
+
},
|
|
80
|
+
"uniqueItems": true
|
|
81
|
+
},
|
|
82
|
+
"external_paramsets": {
|
|
83
|
+
"description": "Array of parameter set references",
|
|
84
|
+
"type": "array",
|
|
85
|
+
"minItems": 0,
|
|
86
|
+
"items": {
|
|
87
|
+
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/parameters/parametersets-v3-schema.json#/definitions/paramset_ref"
|
|
88
|
+
},
|
|
89
|
+
"uniqueItems": true
|
|
90
|
+
},
|
|
91
|
+
"app_data": {
|
|
92
|
+
"description": "Object containing app-specific data",
|
|
93
|
+
"type": "object",
|
|
94
|
+
"additionalProperties": true
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
"required": [
|
|
98
|
+
"id",
|
|
99
|
+
"doc_type",
|
|
100
|
+
"version",
|
|
101
|
+
"primary_pipeline",
|
|
102
|
+
"pipelines"
|
|
103
|
+
],
|
|
104
|
+
"additionalProperties": false,
|
|
105
|
+
"definitions": {
|
|
106
|
+
"canvas_pipeline": {
|
|
107
|
+
"description": "Definition of a single canvas-info pipeline",
|
|
108
|
+
"type": "object",
|
|
109
|
+
"properties": {
|
|
110
|
+
"id": {
|
|
111
|
+
"description": "Unique identifier for this canvas-info pipeline",
|
|
112
|
+
"type": "string"
|
|
113
|
+
},
|
|
114
|
+
"description": {
|
|
115
|
+
"description": "Description for this canvas-info pipeline",
|
|
116
|
+
"type": "string"
|
|
117
|
+
},
|
|
118
|
+
"name": {
|
|
119
|
+
"description": "User-readable for this canvas-info pipeline",
|
|
120
|
+
"type": "string"
|
|
121
|
+
},
|
|
122
|
+
"runtime_ref": {
|
|
123
|
+
"description": "Reference to the id of the runtime associated with the operations in the current pipeline",
|
|
124
|
+
"type": "string"
|
|
125
|
+
},
|
|
126
|
+
"nodes": {
|
|
127
|
+
"description": "Array of canvas nodes for this canvas pipeline",
|
|
128
|
+
"type": "array",
|
|
129
|
+
"minItems": 0,
|
|
130
|
+
"items": {
|
|
131
|
+
"$ref": "#/definitions/canvas_node"
|
|
132
|
+
},
|
|
133
|
+
"uniqueItems": true
|
|
134
|
+
},
|
|
135
|
+
"comments": {
|
|
136
|
+
"description": "Array of canvas comments for this canvas pipeline",
|
|
137
|
+
"type": "array",
|
|
138
|
+
"minItems": 0,
|
|
139
|
+
"items": {
|
|
140
|
+
"$ref": "#/definitions/canvas_comment"
|
|
141
|
+
},
|
|
142
|
+
"uniqueItems": true
|
|
143
|
+
},
|
|
144
|
+
"links": {
|
|
145
|
+
"description": "Array of canvas links for this canvas pipeline",
|
|
146
|
+
"type": "array",
|
|
147
|
+
"minItems": 0,
|
|
148
|
+
"items": {
|
|
149
|
+
"$ref": "#/definitions/canvas_link"
|
|
150
|
+
},
|
|
151
|
+
"uniqueItems": true
|
|
152
|
+
},
|
|
153
|
+
"parameters": {
|
|
154
|
+
"description": "Parameters for this canvas-info pipeline",
|
|
155
|
+
"type": "object",
|
|
156
|
+
"properties": {},
|
|
157
|
+
"additionalProperties": true
|
|
158
|
+
},
|
|
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
|
+
]
|
|
191
|
+
},
|
|
192
|
+
"app_data": {
|
|
193
|
+
"description": "Object containing app-specific data",
|
|
194
|
+
"type": "object",
|
|
195
|
+
"additionalProperties": true
|
|
196
|
+
}
|
|
197
|
+
},
|
|
198
|
+
"required": [
|
|
199
|
+
"id",
|
|
200
|
+
"nodes"
|
|
201
|
+
],
|
|
202
|
+
"additionalProperties": false
|
|
203
|
+
},
|
|
204
|
+
"canvas_node": {
|
|
205
|
+
"oneOf": [
|
|
206
|
+
{
|
|
207
|
+
"$ref": "#/definitions/canvas_execution_node"
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
"$ref": "#/definitions/canvas_supernode"
|
|
211
|
+
},
|
|
212
|
+
{
|
|
213
|
+
"$ref": "#/definitions/canvas_binding_entry_node"
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
"$ref": "#/definitions/canvas_binding_exit_node"
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"$ref": "#/definitions/canvas_model_node"
|
|
220
|
+
}
|
|
221
|
+
]
|
|
222
|
+
},
|
|
223
|
+
"canvas_node_shared_properties": {
|
|
224
|
+
"type": "object",
|
|
225
|
+
"properties": {
|
|
226
|
+
"id": {
|
|
227
|
+
"description": "Unique identifier for canvas node within the current pipeline",
|
|
228
|
+
"type": "string"
|
|
229
|
+
},
|
|
230
|
+
"label": {
|
|
231
|
+
"description": "Label of this canvas execution node.",
|
|
232
|
+
"type": "string"
|
|
233
|
+
},
|
|
234
|
+
"description": {
|
|
235
|
+
"description": "Description of this canvas execution node.",
|
|
236
|
+
"type": "string"
|
|
237
|
+
},
|
|
238
|
+
"class_name": {
|
|
239
|
+
"description": "CSS class name - can be a space separated list of classes",
|
|
240
|
+
"type": "string"
|
|
241
|
+
},
|
|
242
|
+
"style": {
|
|
243
|
+
"description": "A 'style spec' object containing CSS strings to be applied to the SVG objects of the node.",
|
|
244
|
+
"type": ["string", "object"]
|
|
245
|
+
},
|
|
246
|
+
"image": {
|
|
247
|
+
"description": "URL to image source. Although a data URL can be used to embed an image inline, it is not recommended. The 'image' property can also be a JSX object that displays an image using an <svg> element however, JSX images must be set programmatically and cannot be stringified into JSON.",
|
|
248
|
+
"type": ["string", "object"]
|
|
249
|
+
},
|
|
250
|
+
"x_pos": {
|
|
251
|
+
"description": "x-position of this canvas execution node.",
|
|
252
|
+
"type": "number"
|
|
253
|
+
},
|
|
254
|
+
"y_pos": {
|
|
255
|
+
"description": "y-position of this canvas execution node.",
|
|
256
|
+
"type": "number"
|
|
257
|
+
},
|
|
258
|
+
"is_resized": {
|
|
259
|
+
"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
|
+
"type": "boolean"
|
|
261
|
+
},
|
|
262
|
+
"resize_height": {
|
|
263
|
+
"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
|
+
"type": "number"
|
|
265
|
+
},
|
|
266
|
+
"resize_width": {
|
|
267
|
+
"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
|
+
"type": "number"
|
|
269
|
+
},
|
|
270
|
+
"attributes": {
|
|
271
|
+
"description": "additional attributes",
|
|
272
|
+
"type": "string"
|
|
273
|
+
},
|
|
274
|
+
"messages": {
|
|
275
|
+
"description": "An array of messages for the node",
|
|
276
|
+
"type": "array",
|
|
277
|
+
"minItems": 0,
|
|
278
|
+
"items": {
|
|
279
|
+
"$ref": "./pipeline-flow-ui-v3-schema.json#/definitions/message_def"
|
|
280
|
+
},
|
|
281
|
+
"uniqueItems": true
|
|
282
|
+
},
|
|
283
|
+
"palette_image": {
|
|
284
|
+
"description": "Image name for the node displayed in palette. If omitted the image from 'image' field will be used.",
|
|
285
|
+
"type": "string"
|
|
286
|
+
},
|
|
287
|
+
"palette_class_name": {
|
|
288
|
+
"description": "CSS class name applied to the <div> shown in palette for the node",
|
|
289
|
+
"type": "string"
|
|
290
|
+
},
|
|
291
|
+
"palette_disabled": {
|
|
292
|
+
"description": "Indicates whether the node in the palette is disabled. If true, prevents the node being dragged or double-clicked from palette.",
|
|
293
|
+
"type": "boolean"
|
|
294
|
+
},
|
|
295
|
+
"decorations": {
|
|
296
|
+
"description": "Array of decorations used to decorate nodes",
|
|
297
|
+
"type": "array",
|
|
298
|
+
"minItems": 0,
|
|
299
|
+
"items": {
|
|
300
|
+
"$ref": "./pipeline-flow-ui-v3-schema.json#/definitions/decoration_def"
|
|
301
|
+
},
|
|
302
|
+
"uniqueItems": true
|
|
303
|
+
},
|
|
304
|
+
"app_data": {
|
|
305
|
+
"description": "Object containing app-specific data",
|
|
306
|
+
"type": "object",
|
|
307
|
+
"additionalProperties": true
|
|
308
|
+
}
|
|
309
|
+
}
|
|
310
|
+
},
|
|
311
|
+
"canvas_execution_node": {
|
|
312
|
+
"allOf": [
|
|
313
|
+
{
|
|
314
|
+
"description": "Definition of a single canvas execution node",
|
|
315
|
+
"type": "object",
|
|
316
|
+
"properties": {
|
|
317
|
+
"type": {
|
|
318
|
+
"description": "Node type - always 'execution_node'",
|
|
319
|
+
"enum": [
|
|
320
|
+
"execution_node"
|
|
321
|
+
]
|
|
322
|
+
},
|
|
323
|
+
"op": {
|
|
324
|
+
"description": "Operator type identifier",
|
|
325
|
+
"type": "string"
|
|
326
|
+
},
|
|
327
|
+
"ui_parameters": {
|
|
328
|
+
"description": "UI only parameter values for the node",
|
|
329
|
+
"type": "object",
|
|
330
|
+
"properties": {},
|
|
331
|
+
"additionalProperties": true
|
|
332
|
+
},
|
|
333
|
+
"inputs": {
|
|
334
|
+
"$ref": "#/definitions/canvas_ports"
|
|
335
|
+
},
|
|
336
|
+
"outputs": {
|
|
337
|
+
"$ref": "#/definitions/canvas_ports"
|
|
338
|
+
},
|
|
339
|
+
"parameters": {
|
|
340
|
+
"description": "Input parameters for the operator",
|
|
341
|
+
"type": "object",
|
|
342
|
+
"properties": {},
|
|
343
|
+
"additionalProperties": true
|
|
344
|
+
},
|
|
345
|
+
"runtime_ref": {
|
|
346
|
+
"description": "Optional reference to the id of the runtime associated with the current node",
|
|
347
|
+
"type": "string"
|
|
348
|
+
}
|
|
349
|
+
},
|
|
350
|
+
"required": [
|
|
351
|
+
"id",
|
|
352
|
+
"type",
|
|
353
|
+
"op"
|
|
354
|
+
],
|
|
355
|
+
"additionalProperties": false
|
|
356
|
+
},
|
|
357
|
+
{ "$ref": "#/definitions/canvas_node_shared_properties" }
|
|
358
|
+
]
|
|
359
|
+
},
|
|
360
|
+
"canvas_supernode": {
|
|
361
|
+
"allOf": [
|
|
362
|
+
{
|
|
363
|
+
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
|
|
364
|
+
"type": "object",
|
|
365
|
+
"properties": {
|
|
366
|
+
"type": {
|
|
367
|
+
"description": "Node type - always 'super_node' for supernode elements",
|
|
368
|
+
"enum": [
|
|
369
|
+
"super_node"
|
|
370
|
+
]
|
|
371
|
+
},
|
|
372
|
+
"open_with_tool": {
|
|
373
|
+
"description": "Name of the tool which can be used to view or edit the sub-flow for this supernode. The default is 'canvas'",
|
|
374
|
+
"type": "string"
|
|
375
|
+
},
|
|
376
|
+
"subflow_ref": {
|
|
377
|
+
"description": "Refers to the sub-flow associated with this supernode",
|
|
378
|
+
"type": "object",
|
|
379
|
+
"properties": {
|
|
380
|
+
"url": {
|
|
381
|
+
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
|
|
382
|
+
"type": "string"
|
|
383
|
+
},
|
|
384
|
+
"pipeline_id_ref": {
|
|
385
|
+
"description": "Sub-flow identifier reference",
|
|
386
|
+
"type": "string"
|
|
387
|
+
}
|
|
388
|
+
},
|
|
389
|
+
"required": [
|
|
390
|
+
"pipeline_id_ref"
|
|
391
|
+
]
|
|
392
|
+
},
|
|
393
|
+
"is_expanded": {
|
|
394
|
+
"description": "Indicates whether a supernode is shown in expanded state or as a regular node.",
|
|
395
|
+
"type": "boolean"
|
|
396
|
+
},
|
|
397
|
+
"expanded_height": {
|
|
398
|
+
"description": "Height of expanded supernode. If not provided an appropriate height is calculated.",
|
|
399
|
+
"type": "number"
|
|
400
|
+
},
|
|
401
|
+
"expanded_width": {
|
|
402
|
+
"description": "Width of expanded supernode. If not provided an appropriate width is calculated.",
|
|
403
|
+
"type": "number"
|
|
404
|
+
},
|
|
405
|
+
"sub_pipelines": {
|
|
406
|
+
"description": "An array of pipelines referenced when this node is a supernode. This field is only used when the supernode is in a palette or on the clipboard. It will be an empty array when the supernode references an external pipeline.",
|
|
407
|
+
"type": "array",
|
|
408
|
+
"minItems": 0,
|
|
409
|
+
"uniqueItems": true
|
|
410
|
+
},
|
|
411
|
+
"ui_parameters": {
|
|
412
|
+
"description": "UI only parameter values for the node",
|
|
413
|
+
"type": "object",
|
|
414
|
+
"properties": {},
|
|
415
|
+
"additionalProperties": true
|
|
416
|
+
},
|
|
417
|
+
"inputs": {
|
|
418
|
+
"$ref": "#/definitions/canvas_bound_ports"
|
|
419
|
+
},
|
|
420
|
+
"outputs": {
|
|
421
|
+
"$ref": "#/definitions/canvas_bound_ports"
|
|
422
|
+
},
|
|
423
|
+
"parameters": {
|
|
424
|
+
"description": "Input parameters for the supernode",
|
|
425
|
+
"type": "object",
|
|
426
|
+
"properties": {},
|
|
427
|
+
"additionalProperties": true
|
|
428
|
+
}
|
|
429
|
+
},
|
|
430
|
+
"required": [
|
|
431
|
+
"id",
|
|
432
|
+
"type",
|
|
433
|
+
"subflow_ref"
|
|
434
|
+
],
|
|
435
|
+
"additionalProperties": false
|
|
436
|
+
},
|
|
437
|
+
{ "$ref": "#/definitions/canvas_node_shared_properties" }
|
|
438
|
+
]
|
|
439
|
+
},
|
|
440
|
+
"canvas_binding_entry_node": {
|
|
441
|
+
"allOf": [
|
|
442
|
+
{
|
|
443
|
+
"description": "Defines an entry point (source) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
|
|
444
|
+
"type": "object",
|
|
445
|
+
"properties": {
|
|
446
|
+
"type": {
|
|
447
|
+
"description": "Node type - always 'binding' for binding elements",
|
|
448
|
+
"enum": [
|
|
449
|
+
"binding"
|
|
450
|
+
]
|
|
451
|
+
},
|
|
452
|
+
"outputs": {
|
|
453
|
+
"$ref": "#/definitions/canvas_ports"
|
|
454
|
+
},
|
|
455
|
+
"connection": {
|
|
456
|
+
"$ref": "./pipeline-connection-v3-schema.json#/definitions/common_pipeline_connection_def"
|
|
457
|
+
},
|
|
458
|
+
"data_asset": {
|
|
459
|
+
"$ref": "./pipeline-connection-v3-schema.json#/definitions/common_pipeline_data_asset_def"
|
|
460
|
+
},
|
|
461
|
+
"op": {
|
|
462
|
+
"description": "Binding node type identifier",
|
|
463
|
+
"type": "string"
|
|
464
|
+
},
|
|
465
|
+
"ui_parameters": {
|
|
466
|
+
"description": "UI only parameter values for the node",
|
|
467
|
+
"type": "object",
|
|
468
|
+
"properties": {},
|
|
469
|
+
"additionalProperties": true
|
|
470
|
+
},
|
|
471
|
+
"parameters": {
|
|
472
|
+
"description": "Parameters for the binding entry node",
|
|
473
|
+
"type": "object",
|
|
474
|
+
"properties": {},
|
|
475
|
+
"additionalProperties": true
|
|
476
|
+
}
|
|
477
|
+
},
|
|
478
|
+
"required": [
|
|
479
|
+
"id",
|
|
480
|
+
"type",
|
|
481
|
+
"outputs"
|
|
482
|
+
],
|
|
483
|
+
"additionalProperties": false
|
|
484
|
+
},
|
|
485
|
+
{ "$ref": "#/definitions/canvas_node_shared_properties" }
|
|
486
|
+
]
|
|
487
|
+
},
|
|
488
|
+
"canvas_binding_exit_node": {
|
|
489
|
+
"allOf": [
|
|
490
|
+
{
|
|
491
|
+
"description": "Defines an exit point (sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
|
|
492
|
+
"type": "object",
|
|
493
|
+
"properties": {
|
|
494
|
+
"type": {
|
|
495
|
+
"description": "Node type - always 'binding' for binding elements",
|
|
496
|
+
"enum": [
|
|
497
|
+
"binding"
|
|
498
|
+
]
|
|
499
|
+
},
|
|
500
|
+
"inputs": {
|
|
501
|
+
"$ref": "#/definitions/canvas_ports"
|
|
502
|
+
},
|
|
503
|
+
"outputs": {
|
|
504
|
+
"description": "An optional set of output ports, typically used for directing error information out of the binding node.",
|
|
505
|
+
"$ref": "#/definitions/canvas_ports"
|
|
506
|
+
},
|
|
507
|
+
"app_data": {
|
|
508
|
+
"description": "Object containing app-specific data",
|
|
509
|
+
"type": "object",
|
|
510
|
+
"additionalProperties": true
|
|
511
|
+
},
|
|
512
|
+
"connection": {
|
|
513
|
+
"$ref": "./pipeline-connection-v3-schema.json#/definitions/common_pipeline_connection_def"
|
|
514
|
+
},
|
|
515
|
+
"data_asset": {
|
|
516
|
+
"$ref": "./pipeline-connection-v3-schema.json#/definitions/common_pipeline_data_asset_def"
|
|
517
|
+
},
|
|
518
|
+
"op": {
|
|
519
|
+
"description": "Binding node type identifier",
|
|
520
|
+
"type": "string"
|
|
521
|
+
},
|
|
522
|
+
"parameters": {
|
|
523
|
+
"description": "Parameters for the binding exit node",
|
|
524
|
+
"type": "object",
|
|
525
|
+
"properties": {},
|
|
526
|
+
"additionalProperties": true
|
|
527
|
+
}
|
|
528
|
+
},
|
|
529
|
+
"required": [
|
|
530
|
+
"id",
|
|
531
|
+
"type",
|
|
532
|
+
"inputs"
|
|
533
|
+
],
|
|
534
|
+
"additionalProperties": false
|
|
535
|
+
},
|
|
536
|
+
{ "$ref": "#/definitions/canvas_node_shared_properties" }
|
|
537
|
+
]
|
|
538
|
+
},
|
|
539
|
+
"canvas_model_node": {
|
|
540
|
+
"allOf": [
|
|
541
|
+
{
|
|
542
|
+
"description": "Definition of a single predictive model node",
|
|
543
|
+
"type": "object",
|
|
544
|
+
"properties": {
|
|
545
|
+
"type": {
|
|
546
|
+
"description": "Node type - always 'model_node' for model pipeline elements",
|
|
547
|
+
"enum": [
|
|
548
|
+
"model_node"
|
|
549
|
+
]
|
|
550
|
+
},
|
|
551
|
+
"model_ref": {
|
|
552
|
+
"description": "Reference to the binary model",
|
|
553
|
+
"type": "string"
|
|
554
|
+
},
|
|
555
|
+
"inputs": {
|
|
556
|
+
"$ref": "#/definitions/canvas_ports"
|
|
557
|
+
},
|
|
558
|
+
"outputs": {
|
|
559
|
+
"$ref": "#/definitions/canvas_ports"
|
|
560
|
+
},
|
|
561
|
+
"op": {
|
|
562
|
+
"description": "Node type identifier of modeling node that created this model.",
|
|
563
|
+
"type": "string"
|
|
564
|
+
},
|
|
565
|
+
"parameters": {
|
|
566
|
+
"description": "Input parameters for the operator",
|
|
567
|
+
"type": "object",
|
|
568
|
+
"properties": {},
|
|
569
|
+
"additionalProperties": true
|
|
570
|
+
},
|
|
571
|
+
"runtime_ref": {
|
|
572
|
+
"description": "Reference to the runtime associated with the current node",
|
|
573
|
+
"type": "string"
|
|
574
|
+
}
|
|
575
|
+
},
|
|
576
|
+
"required": [
|
|
577
|
+
"id",
|
|
578
|
+
"type",
|
|
579
|
+
"inputs"
|
|
580
|
+
],
|
|
581
|
+
"additionalProperties": false
|
|
582
|
+
},
|
|
583
|
+
{ "$ref": "#/definitions/canvas_node_shared_properties" }
|
|
584
|
+
]
|
|
585
|
+
},
|
|
586
|
+
"canvas_ports": {
|
|
587
|
+
"type": "array",
|
|
588
|
+
"minItems": 0,
|
|
589
|
+
"items": {
|
|
590
|
+
"$ref": "#/definitions/canvas_port"
|
|
591
|
+
},
|
|
592
|
+
"uniqueItems": true
|
|
593
|
+
},
|
|
594
|
+
"canvas_port": {
|
|
595
|
+
"description": "Port definition (input/output) on a node",
|
|
596
|
+
"type": "object",
|
|
597
|
+
"properties": {
|
|
598
|
+
"id": {
|
|
599
|
+
"description": "Unique identifier for the port",
|
|
600
|
+
"type": "string"
|
|
601
|
+
},
|
|
602
|
+
"schema_ref": {
|
|
603
|
+
"description": "Optional data record schema reference associated with the port",
|
|
604
|
+
"type": "string"
|
|
605
|
+
},
|
|
606
|
+
"parameters": {
|
|
607
|
+
"description": "Parameters for the port",
|
|
608
|
+
"type": "object",
|
|
609
|
+
"properties": {},
|
|
610
|
+
"additionalProperties": true
|
|
611
|
+
},
|
|
612
|
+
"cardinality": {
|
|
613
|
+
"description": "Property to capture how many data assets are allowed for this port, e.g., min: 1, max:1 implies you must supply 1 and only 1; min:0, max:1 implies it is optional and a max of one, min:0, max:-1 means it is optional and you can may have any number of data assets. The default value is 1:1 for inputs and 1:-1 for outputs.",
|
|
614
|
+
"type": "object",
|
|
615
|
+
"properties": {
|
|
616
|
+
"min": {
|
|
617
|
+
"description": "Minimum data sets that are required for this port",
|
|
618
|
+
"type": "integer",
|
|
619
|
+
"default": 1
|
|
620
|
+
},
|
|
621
|
+
"max": {
|
|
622
|
+
"description": "Maximum data sets that are allowed on this port. A negative value indicates unlimited. The default value is 1 for inputs and -1 for outputs.",
|
|
623
|
+
"type": "integer"
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
"additionalProperties": false
|
|
627
|
+
},
|
|
628
|
+
"class_name": {
|
|
629
|
+
"description": "CSS class name",
|
|
630
|
+
"type": "string"
|
|
631
|
+
},
|
|
632
|
+
"style": {
|
|
633
|
+
"description": "A 'style spec' object containing CSS strings to be applied to the SVG objects of the port.",
|
|
634
|
+
"type": ["string", "object"]
|
|
635
|
+
},
|
|
636
|
+
"label": {
|
|
637
|
+
"description": "Port name",
|
|
638
|
+
"type": "string"
|
|
639
|
+
},
|
|
640
|
+
"app_data": {
|
|
641
|
+
"description": "Object containing app-specific data",
|
|
642
|
+
"type": "object",
|
|
643
|
+
"additionalProperties": true
|
|
644
|
+
}
|
|
645
|
+
},
|
|
646
|
+
"required": [
|
|
647
|
+
"id"
|
|
648
|
+
],
|
|
649
|
+
"additionalProperties": false
|
|
650
|
+
},
|
|
651
|
+
"canvas_bound_ports": {
|
|
652
|
+
"type": "array",
|
|
653
|
+
"minItems": 0,
|
|
654
|
+
"items": {
|
|
655
|
+
"$ref": "#/definitions/canvas_bound_port"
|
|
656
|
+
},
|
|
657
|
+
"uniqueItems": true
|
|
658
|
+
},
|
|
659
|
+
"canvas_bound_port": {
|
|
660
|
+
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
|
|
661
|
+
"type": "object",
|
|
662
|
+
"properties": {
|
|
663
|
+
"id": {
|
|
664
|
+
"description": "Unique identifier for this port",
|
|
665
|
+
"type": "string"
|
|
666
|
+
},
|
|
667
|
+
"schema_ref": {
|
|
668
|
+
"description": "Optional data record schema associated with the port",
|
|
669
|
+
"type": "string"
|
|
670
|
+
},
|
|
671
|
+
"subflow_node_ref": {
|
|
672
|
+
"description": "Optional node id binding within the current document.",
|
|
673
|
+
"type": "string"
|
|
674
|
+
},
|
|
675
|
+
"parameters": {
|
|
676
|
+
"description": "Parameters for the binding port",
|
|
677
|
+
"type": "object",
|
|
678
|
+
"properties": {},
|
|
679
|
+
"additionalProperties": true
|
|
680
|
+
},
|
|
681
|
+
"cardinality": {
|
|
682
|
+
"description": "Property to capture how many data assets are allowed for this port, e.g., min: 1, max:1 implies you must supply 1 and only 1; min:0, max:1 implies it is optional and a max of one, min:0, max:-1 means it is optional and you can may have any number of data assets. The default value is 1:1 for inputs and 1:-1 for outputs.",
|
|
683
|
+
"type": "object",
|
|
684
|
+
"properties": {
|
|
685
|
+
"min": {
|
|
686
|
+
"description": "Minimum data sets that are required for this port",
|
|
687
|
+
"type": "integer",
|
|
688
|
+
"default": 1
|
|
689
|
+
},
|
|
690
|
+
"max": {
|
|
691
|
+
"description": "Maximum data sets that are allowed on this port. A negative value indicates unlimited. The default value is 1 for inputs and -1 for outputs.",
|
|
692
|
+
"type": "integer"
|
|
693
|
+
}
|
|
694
|
+
},
|
|
695
|
+
"additionalProperties": false
|
|
696
|
+
},
|
|
697
|
+
"class_name": {
|
|
698
|
+
"description": "CSS class name",
|
|
699
|
+
"type": "string"
|
|
700
|
+
},
|
|
701
|
+
"style": {
|
|
702
|
+
"description": "A 'style spec' object containing CSS strings to be applied to the SVG objects of the port.",
|
|
703
|
+
"type": ["string", "object"]
|
|
704
|
+
},
|
|
705
|
+
"label": {
|
|
706
|
+
"description": "Port name",
|
|
707
|
+
"type": "string"
|
|
708
|
+
},
|
|
709
|
+
"app_data": {
|
|
710
|
+
"description": "Object containing app-specific data",
|
|
711
|
+
"type": "object",
|
|
712
|
+
"additionalProperties": true
|
|
713
|
+
}
|
|
714
|
+
},
|
|
715
|
+
"required": [
|
|
716
|
+
"id"
|
|
717
|
+
],
|
|
718
|
+
"additionalProperties": false
|
|
719
|
+
},
|
|
720
|
+
"canvas_comment": {
|
|
721
|
+
"type": "object",
|
|
722
|
+
"properties": {
|
|
723
|
+
"id": {
|
|
724
|
+
"description": "Comment identifier. Must be unique.",
|
|
725
|
+
"type": "string"
|
|
726
|
+
},
|
|
727
|
+
"x_pos": {
|
|
728
|
+
"description": "Horizontal comment position",
|
|
729
|
+
"type": "number"
|
|
730
|
+
},
|
|
731
|
+
"y_pos": {
|
|
732
|
+
"description": "Vertical comment position",
|
|
733
|
+
"type": "number"
|
|
734
|
+
},
|
|
735
|
+
"width": {
|
|
736
|
+
"description": "Comment width",
|
|
737
|
+
"type": "number",
|
|
738
|
+
"minimum": 10
|
|
739
|
+
},
|
|
740
|
+
"height": {
|
|
741
|
+
"description": "Comment height",
|
|
742
|
+
"type": "number",
|
|
743
|
+
"minimum": 10
|
|
744
|
+
},
|
|
745
|
+
"content": {
|
|
746
|
+
"description": "Comment content",
|
|
747
|
+
"type": "string"
|
|
748
|
+
},
|
|
749
|
+
"class_name": {
|
|
750
|
+
"description": "CSS class(es) to apply to the comment",
|
|
751
|
+
"type": "string"
|
|
752
|
+
},
|
|
753
|
+
"content_type": {
|
|
754
|
+
"description": "Type of content",
|
|
755
|
+
"type": "string"
|
|
756
|
+
},
|
|
757
|
+
"formats": {
|
|
758
|
+
"description": "Type of content",
|
|
759
|
+
"type": "array",
|
|
760
|
+
"items": {
|
|
761
|
+
"type": "object",
|
|
762
|
+
"properties": {
|
|
763
|
+
"field": {
|
|
764
|
+
"type": "string"
|
|
765
|
+
},
|
|
766
|
+
"value": {
|
|
767
|
+
"type": "string"
|
|
768
|
+
}
|
|
769
|
+
},
|
|
770
|
+
"additionalProperties": false,
|
|
771
|
+
"required": [
|
|
772
|
+
"field"
|
|
773
|
+
]
|
|
774
|
+
}
|
|
775
|
+
},
|
|
776
|
+
"style": {
|
|
777
|
+
"description": "A 'style spec' object containing CSS strings to be applied to the SVG objects of the comment.",
|
|
778
|
+
"type": ["string", "object"],
|
|
779
|
+
"additionalProperties": false
|
|
780
|
+
}
|
|
781
|
+
},
|
|
782
|
+
"required": [
|
|
783
|
+
"id",
|
|
784
|
+
"x_pos",
|
|
785
|
+
"y_pos",
|
|
786
|
+
"width",
|
|
787
|
+
"height"
|
|
788
|
+
],
|
|
789
|
+
"additionalProperties": true
|
|
790
|
+
},
|
|
791
|
+
"canvas_link": {
|
|
792
|
+
"oneOf": [
|
|
793
|
+
{
|
|
794
|
+
"$ref": "#/definitions/canvas_comment_link"
|
|
795
|
+
},
|
|
796
|
+
{
|
|
797
|
+
"$ref": "#/definitions/canvas_node_link"
|
|
798
|
+
},
|
|
799
|
+
{
|
|
800
|
+
"$ref": "#/definitions/canvas_association_link"
|
|
801
|
+
}
|
|
802
|
+
]
|
|
803
|
+
},
|
|
804
|
+
"canvas_comment_link": {
|
|
805
|
+
"description": "Comment link definition",
|
|
806
|
+
"type": "object",
|
|
807
|
+
"properties": {
|
|
808
|
+
"id": {
|
|
809
|
+
"description": "Unique id of this comment link.",
|
|
810
|
+
"type": "string"
|
|
811
|
+
},
|
|
812
|
+
"type": {
|
|
813
|
+
"description": "Link type - always 'commentLink' for links from comments to nodes",
|
|
814
|
+
"enum": [
|
|
815
|
+
"commentLink"
|
|
816
|
+
]
|
|
817
|
+
},
|
|
818
|
+
"src_node_id": {
|
|
819
|
+
"description": "ID of the comment this link connects from.",
|
|
820
|
+
"type": "string"
|
|
821
|
+
},
|
|
822
|
+
"trg_node_id": {
|
|
823
|
+
"description": "ID of the node this link connects to.",
|
|
824
|
+
"type": "string"
|
|
825
|
+
},
|
|
826
|
+
"class_name": {
|
|
827
|
+
"description": "CSS class name for link styling",
|
|
828
|
+
"type": "string"
|
|
829
|
+
},
|
|
830
|
+
"style": {
|
|
831
|
+
"description": "A 'style spec' object containing CSS strings to be applied to the SVG objects of the comment link.",
|
|
832
|
+
"type": ["string", "object"]
|
|
833
|
+
},
|
|
834
|
+
"decorations": {
|
|
835
|
+
"description": "Array of decorations used to decorate node links",
|
|
836
|
+
"type": "array",
|
|
837
|
+
"minItems": 0,
|
|
838
|
+
"items": {
|
|
839
|
+
"$ref": "./pipeline-flow-ui-v3-schema.json#/definitions/decoration_def"
|
|
840
|
+
},
|
|
841
|
+
"uniqueItems": true
|
|
842
|
+
}
|
|
843
|
+
},
|
|
844
|
+
"required": [
|
|
845
|
+
"node_ref"
|
|
846
|
+
],
|
|
847
|
+
"additionalProperties": true
|
|
848
|
+
},
|
|
849
|
+
"canvas_node_link": {
|
|
850
|
+
"description": "Node link definition",
|
|
851
|
+
"type": "object",
|
|
852
|
+
"properties": {
|
|
853
|
+
"id": {
|
|
854
|
+
"description": "Unique id of this link within the pipelineFlow.",
|
|
855
|
+
"type": "string"
|
|
856
|
+
},
|
|
857
|
+
"type": {
|
|
858
|
+
"description": "Link type - always 'nodeLink' for directional links from nodes to nodes",
|
|
859
|
+
"enum": [
|
|
860
|
+
"nodeLink"
|
|
861
|
+
]
|
|
862
|
+
},
|
|
863
|
+
"src_node_id": {
|
|
864
|
+
"description": "ID of the source node this link connects from.",
|
|
865
|
+
"type": "string"
|
|
866
|
+
},
|
|
867
|
+
"src_node_port_id": {
|
|
868
|
+
"description": "Optional ID of the port on the source node this link connects from. Defaults to the first port if omitted.",
|
|
869
|
+
"type": "string"
|
|
870
|
+
},
|
|
871
|
+
"trg_node_id": {
|
|
872
|
+
"description": "ID of the target node this link connects to.",
|
|
873
|
+
"type": "string"
|
|
874
|
+
},
|
|
875
|
+
"trg_node_port_id": {
|
|
876
|
+
"description": "Optional ID of the port on the target node this link connects from. Defaults to the first port if omitted.",
|
|
877
|
+
"type": "string"
|
|
878
|
+
},
|
|
879
|
+
"src_pos": {
|
|
880
|
+
"x_pos": "number",
|
|
881
|
+
"y_pos": "number"
|
|
882
|
+
},
|
|
883
|
+
"trg_pos": {
|
|
884
|
+
"x_pos": "number",
|
|
885
|
+
"y_pos": "number"
|
|
886
|
+
},
|
|
887
|
+
"link_name": {
|
|
888
|
+
"description": "optional link name (used in parameter sets when there are multiple input sources)",
|
|
889
|
+
"type": "string"
|
|
890
|
+
},
|
|
891
|
+
"type_attr": {
|
|
892
|
+
"description": "Optional type attribute for the link. This can store optional atribute info.",
|
|
893
|
+
"type": "string"
|
|
894
|
+
},
|
|
895
|
+
"description": {
|
|
896
|
+
"description": "User-defined description",
|
|
897
|
+
"type": "string"
|
|
898
|
+
},
|
|
899
|
+
"class_name": {
|
|
900
|
+
"description": "CSS class name",
|
|
901
|
+
"type": "string"
|
|
902
|
+
},
|
|
903
|
+
"style": {
|
|
904
|
+
"description": "A 'style spec' object containing CSS strings to be applied to the SVG objects of the node to node link.",
|
|
905
|
+
"type": ["string", "object"]
|
|
906
|
+
},
|
|
907
|
+
"decorations": {
|
|
908
|
+
"description": "Array of decorations used to decorate node links",
|
|
909
|
+
"type": "array",
|
|
910
|
+
"minItems": 0,
|
|
911
|
+
"items": {
|
|
912
|
+
"$ref": "./pipeline-flow-ui-v3-schema.json#/definitions/decoration_def"
|
|
913
|
+
},
|
|
914
|
+
"uniqueItems": true
|
|
915
|
+
},
|
|
916
|
+
"app_data": {
|
|
917
|
+
"description": "Object containing app-specific data",
|
|
918
|
+
"type": "object",
|
|
919
|
+
"additionalProperties": true
|
|
920
|
+
}
|
|
921
|
+
},
|
|
922
|
+
"required": [
|
|
923
|
+
"node_id_ref"
|
|
924
|
+
],
|
|
925
|
+
"additionalProperties": false
|
|
926
|
+
},
|
|
927
|
+
"canvas_association_link": {
|
|
928
|
+
"description": "Association link definition",
|
|
929
|
+
"type": "object",
|
|
930
|
+
"properties": {
|
|
931
|
+
"id": {
|
|
932
|
+
"description": "Unique id of this link within the pipelineFlow.",
|
|
933
|
+
"type": "string"
|
|
934
|
+
},
|
|
935
|
+
"type": {
|
|
936
|
+
"description": "Link type - always 'associationLink' for associations between two nodes",
|
|
937
|
+
"enum": [
|
|
938
|
+
"associationLink"
|
|
939
|
+
]
|
|
940
|
+
},
|
|
941
|
+
"src_node_id": {
|
|
942
|
+
"description": "ID of the source node of the association.",
|
|
943
|
+
"type": "string"
|
|
944
|
+
},
|
|
945
|
+
"trg_node_id": {
|
|
946
|
+
"description": "ID of the target node of the association.",
|
|
947
|
+
"type": "string"
|
|
948
|
+
},
|
|
949
|
+
"class_name": {
|
|
950
|
+
"description": "CSS class name",
|
|
951
|
+
"type": "string"
|
|
952
|
+
},
|
|
953
|
+
"decorations": {
|
|
954
|
+
"description": "Array of decorations used to decorate node links",
|
|
955
|
+
"type": "array",
|
|
956
|
+
"minItems": 0,
|
|
957
|
+
"items": {
|
|
958
|
+
"$ref": "./pipeline-flow-ui-v3-schema.json#/definitions/decoration_def"
|
|
959
|
+
},
|
|
960
|
+
"uniqueItems": true
|
|
961
|
+
},
|
|
962
|
+
"app_data": {
|
|
963
|
+
"description": "Object containing app-specific data",
|
|
964
|
+
"type": "object",
|
|
965
|
+
"additionalProperties": true
|
|
966
|
+
}
|
|
967
|
+
},
|
|
968
|
+
"required": [
|
|
969
|
+
"node_id_ref"
|
|
970
|
+
],
|
|
971
|
+
"additionalProperties": false
|
|
972
|
+
}
|
|
973
|
+
}
|
|
974
|
+
}
|
|
@@ -65,9 +65,7 @@
|
|
|
65
65
|
"properties": {
|
|
66
66
|
"description": "Properties controlling how the data asset is used.",
|
|
67
67
|
"type": "object",
|
|
68
|
-
"additionalProperties":
|
|
69
|
-
"type": "object"
|
|
70
|
-
},
|
|
68
|
+
"additionalProperties": true,
|
|
71
69
|
"properties": {
|
|
72
70
|
"attachment_ref": {
|
|
73
71
|
"description": "The ID of the data asset attachment to use. If not specified and used as a source, the first suitable attachment found will be used. If not specified and used as a target, a new attachment will be created.",
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
"properties": {},
|
|
7
7
|
"additionalProperties": true,
|
|
8
8
|
"definitions": {
|
|
9
|
-
"
|
|
9
|
+
"pipeline_flow_ui_def": {
|
|
10
10
|
"description": "Top level UI information",
|
|
11
11
|
"type": "object",
|
|
12
12
|
"properties": {
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
},
|
|
26
26
|
"additionalProperties": true
|
|
27
27
|
},
|
|
28
|
-
"
|
|
28
|
+
"pipeline_ui_def": {
|
|
29
29
|
"description": "Pipeline level UI information",
|
|
30
30
|
"type": "object",
|
|
31
31
|
"properties": {
|
|
@@ -173,9 +173,6 @@
|
|
|
173
173
|
"description": "An array of pipelines referenced when this node is a supernode. This field is only used when the supernode is in a palette or on the clipboard. It will be an empty array when the supernode references an external pipeline.",
|
|
174
174
|
"type": "array",
|
|
175
175
|
"minItems": 0,
|
|
176
|
-
"items": {
|
|
177
|
-
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v3-schema.json#/definitions/pipeline_def"
|
|
178
|
-
},
|
|
179
176
|
"uniqueItems": true
|
|
180
177
|
},
|
|
181
178
|
"attributes": {
|
|
@@ -300,23 +297,20 @@
|
|
|
300
297
|
"additionalProperties": false
|
|
301
298
|
},
|
|
302
299
|
"decoration_def": {
|
|
300
|
+
"oneOf": [
|
|
301
|
+
{
|
|
302
|
+
"$ref": "#/definitions/node_decoration_def"
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
"$ref": "#/definitions/link_decoration_def"
|
|
306
|
+
}
|
|
307
|
+
]
|
|
308
|
+
},
|
|
309
|
+
"node_decoration_def": {
|
|
303
310
|
"description": "Decoration used to decorate a node",
|
|
304
|
-
"type": "object",
|
|
305
311
|
"properties": {
|
|
306
|
-
"id": {
|
|
307
|
-
"description": "An identifier used to identify the decoration",
|
|
308
|
-
"type": "string"
|
|
309
|
-
},
|
|
310
|
-
"hotspot": {
|
|
311
|
-
"description": "Indicates whether the decorator is a hotspot or not. ie does it send an event to consuming app. when clicked",
|
|
312
|
-
"type": "boolean"
|
|
313
|
-
},
|
|
314
|
-
"class_name": {
|
|
315
|
-
"description": "CSS class name for decoration styling",
|
|
316
|
-
"type": "string"
|
|
317
|
-
},
|
|
318
312
|
"position": {
|
|
319
|
-
"description": "Indicates an anchor point on the node
|
|
313
|
+
"description": "Indicates an anchor point on the node at which the decoration will be displayed.",
|
|
320
314
|
"enum": [
|
|
321
315
|
"topLeft",
|
|
322
316
|
"topCenter",
|
|
@@ -326,29 +320,188 @@
|
|
|
326
320
|
"middleRight",
|
|
327
321
|
"bottomLeft",
|
|
328
322
|
"bottomCenter",
|
|
329
|
-
"bottomRight"
|
|
323
|
+
"bottomRight"
|
|
324
|
+
]
|
|
325
|
+
}
|
|
326
|
+
},
|
|
327
|
+
"oneOf": [
|
|
328
|
+
{
|
|
329
|
+
"$ref": "#/definitions/image_decoration_def"
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
"$ref": "#/definitions/label_decoration_def"
|
|
333
|
+
},
|
|
334
|
+
{
|
|
335
|
+
"$ref": "#/definitions/shape_decoration_def"
|
|
336
|
+
},
|
|
337
|
+
{
|
|
338
|
+
"$ref": "#/definitions/jsx_decoration_def"
|
|
339
|
+
}
|
|
340
|
+
]
|
|
341
|
+
},
|
|
342
|
+
"link_decoration_def": {
|
|
343
|
+
"description": "Decoration used to decorate a link",
|
|
344
|
+
"properties": {
|
|
345
|
+
"position": {
|
|
346
|
+
"description": "Indicates an anchor point on the link at which the decoration will be displayed.",
|
|
347
|
+
"enum": [
|
|
330
348
|
"source",
|
|
331
349
|
"middle",
|
|
332
350
|
"target"
|
|
333
351
|
]
|
|
334
352
|
},
|
|
353
|
+
"distance": {
|
|
354
|
+
"description": "Only applicable to straight link lines. Will move the decoration the specified number of pixels from its 'position'.",
|
|
355
|
+
"type": "integer"
|
|
356
|
+
}
|
|
357
|
+
},
|
|
358
|
+
"oneOf": [
|
|
359
|
+
{
|
|
360
|
+
"$ref": "#/definitions/image_decoration_def"
|
|
361
|
+
},
|
|
362
|
+
{
|
|
363
|
+
"$ref": "#/definitions/label_decoration_def"
|
|
364
|
+
},
|
|
365
|
+
{
|
|
366
|
+
"$ref": "#/definitions/shape_decoration_def"
|
|
367
|
+
},
|
|
368
|
+
{
|
|
369
|
+
"$ref": "#/definitions/jsx_decoration_def"
|
|
370
|
+
}
|
|
371
|
+
]
|
|
372
|
+
},
|
|
373
|
+
"image_decoration_def": {
|
|
374
|
+
"description": "Image decoration properties including shared properties.",
|
|
375
|
+
"type": "object",
|
|
376
|
+
"allOf": [
|
|
377
|
+
{
|
|
378
|
+
"properties": {
|
|
379
|
+
"image": {
|
|
380
|
+
"description": "Image displayed at the decoration position. Provide either this or a label.",
|
|
381
|
+
"type": "string"
|
|
382
|
+
},
|
|
383
|
+
"outline": {
|
|
384
|
+
"description": "If true and outline is drawn around the image.",
|
|
385
|
+
"type": "boolean"
|
|
386
|
+
}
|
|
387
|
+
}
|
|
388
|
+
},
|
|
389
|
+
{ "$ref": "#/definitions/shared_decoration_def" }
|
|
390
|
+
]
|
|
391
|
+
},
|
|
392
|
+
"label_decoration_def": {
|
|
393
|
+
"description": "Label decoration properties including shared properties.",
|
|
394
|
+
"type": "object",
|
|
395
|
+
"allOf": [
|
|
396
|
+
{
|
|
397
|
+
"properties": {
|
|
398
|
+
"label": {
|
|
399
|
+
"description": "Label displayed at the decoration position. Provide either this or an image.",
|
|
400
|
+
"type": "string"
|
|
401
|
+
},
|
|
402
|
+
"label_editable": {
|
|
403
|
+
"description": "If true, the label decoration can be edited. It displays an edit icon which can be clicked to enter edit mode.",
|
|
404
|
+
"type": "boolean"
|
|
405
|
+
},
|
|
406
|
+
"label_align": {
|
|
407
|
+
"description": "The alignment of the label.",
|
|
408
|
+
"enum": [
|
|
409
|
+
"left",
|
|
410
|
+
"center"
|
|
411
|
+
]
|
|
412
|
+
},
|
|
413
|
+
"label_single_line": {
|
|
414
|
+
"description": "If true, the label is displayed as a single line and is truncated at the width.",
|
|
415
|
+
"type": "boolean"
|
|
416
|
+
},
|
|
417
|
+
"label_max_characters": {
|
|
418
|
+
"description": "The maximum number of characters that can be entered in the label decoration when it is editable.",
|
|
419
|
+
"type": "integer"
|
|
420
|
+
},
|
|
421
|
+
"label_allow_return_key": {
|
|
422
|
+
"description": "If false, pressing the return key in edit mode will not do anything: label will wrap at width. If true, return will enter a newline character. ",
|
|
423
|
+
"type": "boolean"
|
|
424
|
+
}
|
|
425
|
+
}
|
|
426
|
+
},
|
|
427
|
+
{ "$ref": "#/definitions/shared_decoration_def" }
|
|
428
|
+
]
|
|
429
|
+
},
|
|
430
|
+
"shape_decoration_def": {
|
|
431
|
+
"description": "Shape decoration properties including shared properties.",
|
|
432
|
+
"type": "object",
|
|
433
|
+
"allOf": [
|
|
434
|
+
{
|
|
435
|
+
"properties": {
|
|
436
|
+
"path": {
|
|
437
|
+
"description": "An SVG path that describes a shape to be drawn at the decoration position.",
|
|
438
|
+
"type": "string"
|
|
439
|
+
}
|
|
440
|
+
}
|
|
441
|
+
},
|
|
442
|
+
{ "$ref": "#/definitions/shared_decoration_def" }
|
|
443
|
+
]
|
|
444
|
+
},
|
|
445
|
+
"jsx_decoration_def": {
|
|
446
|
+
"description": "JSX decoration properties including shared properties These are never serialized in the pipeline flow.",
|
|
447
|
+
"type": "object",
|
|
448
|
+
"allOf": [
|
|
449
|
+
{
|
|
450
|
+
"properties": {
|
|
451
|
+
"jsx": {
|
|
452
|
+
"description": "A JSX expression that will be used to display the content of the decoration.",
|
|
453
|
+
"type": "object"
|
|
454
|
+
}
|
|
455
|
+
}
|
|
456
|
+
},
|
|
457
|
+
{ "$ref": "#/definitions/shared_decoration_def" }
|
|
458
|
+
]
|
|
459
|
+
},
|
|
460
|
+
"shared_decoration_def": {
|
|
461
|
+
"description": "Shared properties across all types of decoration.",
|
|
462
|
+
"type": "object",
|
|
463
|
+
"properties": {
|
|
464
|
+
"id": {
|
|
465
|
+
"description": "A unique identifier used to identify the decoration",
|
|
466
|
+
"type": "string"
|
|
467
|
+
},
|
|
335
468
|
"x_pos": {
|
|
336
|
-
"description": "X position of the decorator relative to the
|
|
469
|
+
"description": "X position of the decorator relative to the decorations's position field.",
|
|
337
470
|
"type": "integer"
|
|
338
471
|
},
|
|
339
472
|
"y_pos": {
|
|
340
|
-
"description": "Y position of the decorator relative to the
|
|
473
|
+
"description": "Y position of the decorator relative to the decorations's position field.",
|
|
341
474
|
"type": "integer"
|
|
342
475
|
},
|
|
343
|
-
"
|
|
344
|
-
"description": "
|
|
476
|
+
"width": {
|
|
477
|
+
"description": "Display width of decoration.",
|
|
478
|
+
"type": "integer"
|
|
479
|
+
},
|
|
480
|
+
"height": {
|
|
481
|
+
"description": "Display height of decoration.",
|
|
482
|
+
"type": "integer"
|
|
483
|
+
},
|
|
484
|
+
"hotspot": {
|
|
485
|
+
"description": "Indicates whether the decorator is a hotspot or not. If true, it calls sends an event to the host app. when clicked",
|
|
486
|
+
"type": "boolean"
|
|
487
|
+
},
|
|
488
|
+
"class_name": {
|
|
489
|
+
"description": "CSS class name for decoration styling. It can be a space-separated list of classes.",
|
|
345
490
|
"type": "string"
|
|
346
491
|
},
|
|
347
|
-
"
|
|
348
|
-
"description": "
|
|
492
|
+
"tooltip": {
|
|
493
|
+
"description": "Tooltip text for the decoration.",
|
|
349
494
|
"type": "string"
|
|
495
|
+
},
|
|
496
|
+
"temporary": {
|
|
497
|
+
"description": "If set to true, the decoration will not be serialized in the pipeline flow.",
|
|
498
|
+
"type": "boolean"
|
|
350
499
|
}
|
|
351
|
-
}
|
|
500
|
+
},
|
|
501
|
+
"required": [
|
|
502
|
+
"id"
|
|
503
|
+
]
|
|
504
|
+
|
|
352
505
|
},
|
|
353
506
|
"message_def": {
|
|
354
507
|
"description": "Node message definition",
|
|
@@ -80,7 +80,7 @@
|
|
|
80
80
|
"type": "object",
|
|
81
81
|
"properties": {
|
|
82
82
|
"ui_data": {
|
|
83
|
-
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/
|
|
83
|
+
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/pipeline_flow_ui_def"
|
|
84
84
|
}
|
|
85
85
|
},
|
|
86
86
|
"additionalProperties": true
|
|
@@ -135,7 +135,7 @@
|
|
|
135
135
|
"type": "object",
|
|
136
136
|
"properties": {
|
|
137
137
|
"ui_data": {
|
|
138
|
-
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/
|
|
138
|
+
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v3-schema.json#/definitions/pipeline_ui_def"
|
|
139
139
|
}
|
|
140
140
|
},
|
|
141
141
|
"additionalProperties": true
|
|
@@ -603,7 +603,8 @@
|
|
|
603
603
|
},
|
|
604
604
|
"description": {
|
|
605
605
|
"description": "Deprecated - use description in pipeline-flow-ui-v3-schema.json#/definitions/node_link_info_def instead.",
|
|
606
|
-
"type": "string"
|
|
606
|
+
"type": "string",
|
|
607
|
+
"deprecated": true
|
|
607
608
|
},
|
|
608
609
|
"app_data": {
|
|
609
610
|
"description": "Object containing app-specific data",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@elyra/pipeline-schemas",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.80",
|
|
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",
|
|
@@ -13,5 +13,7 @@
|
|
|
13
13
|
"url": "https://github.com/elyra-ai/pipeline-schemas/issues"
|
|
14
14
|
},
|
|
15
15
|
"devDependencies": {},
|
|
16
|
-
"dependencies": {
|
|
16
|
+
"dependencies": {
|
|
17
|
+
"json-schema-to-typescript": "^15.0.4"
|
|
18
|
+
}
|
|
17
19
|
}
|