diff --git a/common-canvas/form/examples/Derive_form.json b/common-canvas/form/examples/Derive_form.json deleted file mode 100644 index a7e549a..0000000 --- a/common-canvas/form/examples/Derive_form.json +++ /dev/null @@ -1,558 +0,0 @@ -{ - "title": { - "key": null, - "ref": null, - "props": { - "id": "dialog.nodePropertiesTitle", - "values": {} - }, - "_owner": null, - "_store": {} - }, - "formData": { - "componentId": "derive", - "label": "Derive", - "editorSize": "large", - "uiItems": [ - { - "itemType": "primaryTabs", - "tabs": [ - { - "text": "Settings", - "group": "basic-settings", - "content": { - "itemType": "panel", - "panel": { - "id": "basic-settings", - "panelType": "general", - "uiItems": [ - { - "itemType": "control", - "control": { - "name": "new_name", - "label": { - "text": "Derive field" - }, - "separateLabel": true, - "controlType": "textfield", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - } - } - }, - { - "itemType": "control", - "control": { - "name": "formula_expr", - "label": { - "text": "Expression" - }, - "separateLabel": true, - "controlType": "expression", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - } - } - }, - { - "itemType": "control", - "control": { - "name": "formula_measure_type", - "label": { - "text": "Measurement" - }, - "separateLabel": true, - "controlType": "oneofselect", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - }, - "values": [ - "Range", - "Discrete", - "Flag", - "Set", - "OrderedSet", - "Typeless", - "Collection", - "Geospatial" - ], - "valueLabels": [ - "Range", - "Discrete", - "Flag", - "Set", - "Ordered Set", - "Typeless", - "Collection", - "Geospatial" - ] - } - } - ] - } - } - }, - { - "text": "Annotations", - "group": "annotations", - "content": { - "itemType": "panel", - "panel": { - "id": "annotations", - "panelType": "general", - "uiItems": [ - { - "itemType": "control", - "control": { - "name": "use_custom_name", - "label": { - "text": "Custom name" - }, - "separateLabel": false, - "controlType": "checkbox", - "valueDef": { - "propType": "boolean", - "isList": false, - "isMap": false - } - } - }, - { - "itemType": "control", - "control": { - "name": "custom_name", - "label": { - "text": "" - }, - "separateLabel": true, - "controlType": "textfield", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - } - } - }, - { - "itemType": "control", - "control": { - "name": "annotation", - "label": { - "text": "Annotation" - }, - "separateLabel": true, - "controlType": "textarea", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - } - } - } - ] - } - } - } - ] - } - ], - "buttons": [ - { - "id": "ok", - "text": "OK", - "isPrimary": true, - "url": "" - }, - { - "id": "cancel", - "text": "Cancel", - "isPrimary": false, - "url": "" - } - ], - "data": { - "currentParameters": { - "formula_measure_type": "Default", - "annotation": "", - "new_name": "Na_to_K", - "formula_expr": "Na/K", - "use_custom_name": false, - "custom_name": "Na_to_K" - }, - "datasetMetadata": [ - { - "id": "schema1", - "fields": [ - { - "name": "Age", - "type": "integer", - "metadata": { - "description": "", - "measure": "range", - "modeling_role": "input" - } - }, - { - "name": "Sex", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - }, - { - "name": "BP", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - }, - { - "name": "Cholesterol", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - }, - { - "name": "Na", - "type": "double", - "metadata": { - "description": "", - "measure": "range", - "modeling_role": "input" - } - }, - { - "name": "K", - "type": "double", - "metadata": { - "description": "", - "measure": "range", - "modeling_role": "input" - } - }, - { - "name": "Drug", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - } - ] - } - ], - "conditions": [ - { - "enabled": { - "paramNames": [ - "new_name" - ], - "evaluate": { - "condition": { - "param": "formula_expr", - "op": "notContains", - "value": "!" - } - } - } - }, - { - "enabled": { - "paramNames": [ - "formula_expr" - ], - "evaluate": { - "condition": { - "param": "new_name", - "op": "isNotEmpty" - } - } - } - }, - { - "enabled": { - "paramNames": [ - "annotation" - ], - "evaluate": { - "condition": { - "param": "custom_name", - "op": "isNotEmpty" - } - } - } - }, - { - "visible": { - "paramNames": [ - "annotation" - ], - "evaluate": { - "condition": { - "param": "custom_name", - "op": "isNotEmpty" - } - } - } - }, - { - "validation": { - "fail_message": { - "type": "warning", - "message": { - "default": "Either Measurement:Range is selected or Expression should contain '/'", - "resource_key": "formula_expr_not_valid" - }, - "focusParam": "formula_expr" - }, - "evaluate": { - "or": [ - { - "condition": { - "param": "formula_measure_type", - "op": "contains", - "value": "Range" - } - }, - { - "condition": { - "param": "formula_expr", - "op": "contains", - "value": "/" - } - } - ] - } - } - }, - { - "validation": { - "fail_message": { - "type": "error", - "message": { - "default": "Field cannot be empty nor contain \"quotes\"", - "resource_key": "new_name" - }, - "focusParam": "new_name" - }, - "evaluate": { - "and": [ - { - "condition": { - "param": "new_name", - "op": "isNotEmpty" - } - }, - { - "condition": { - "param": "new_name", - "op": "notContains", - "value": "\"" - } - }, - { - "condition": { - "param": "new_name", - "op": "notContains", - "value": "'" - } - } - ] - } - } - }, - { - "validation": { - "fail_message": { - "type": "error", - "message": { - "default": "Field cannot contain \"quote(s)\"", - "resource_key": "formula_expr" - }, - "focusParam": "formula_expr" - }, - "evaluate": { - "and": [ - { - "condition": { - "param": "formula_expr", - "op": "notContains", - "value": "'" - } - }, - { - "condition": { - "param": "formula_expr", - "op": "notContains", - "value": "\"" - } - } - ] - } - } - }, - { - "validation": { - "fail_message": { - "type": "warning", - "message": { - "default": "Field cannot contain ttt", - "resource_key": "formula_expr" - }, - "focusParam": "formula_expr" - }, - "evaluate": { - "condition": { - "param": "formula_expr", - "op": "notContains", - "value": "ttt" - } - } - } - }, - { - "validation": { - "fail_message": { - "type": "error", - "message": { - "default": "Field cannot be default", - "resource_key": "formula_measure_type" - }, - "focusParam": "formula_measure_type" - }, - "evaluate": { - "condition": { - "param": "formula_measure_type", - "op": "notContains", - "value": "Default" - } - } - } - }, - { - "validation": { - "fail_message": { - "type": "error", - "message": { - "default": "Field cannot contain \"quotes\"", - "resource_key": "custom_name" - }, - "focusParam": "custom_name" - }, - "evaluate": { - "and": [ - { - "condition": { - "param": "custom_name", - "op": "notContains", - "value": "'" - } - }, - { - "condition": { - "param": "custom_name", - "op": "notContains", - "value": "\"" - } - } - ] - } - } - }, - { - "validation": { - "fail_message": { - "type": "error", - "message": { - "default": "Field cannot be empty nor contain \"quotes\"", - "resource_key": "annotation" - }, - "focusParam": "annotations" - }, - "evaluate": { - "and": [ - { - "condition": { - "param": "annotation", - "op": "isNotEmpty" - } - }, - { - "condition": { - "param": "annotation", - "op": "notContains", - "value": "\"" - } - }, - { - "condition": { - "param": "annotation", - "op": "notContains", - "value": "'" - } - } - ] - } - } - }, - { - "validation": { - "fail_message": { - "type": "warning", - "message": { - "default": "Annotation is empty when there is a custom name", - "resource_key": "custom_name" - }, - "focusParam": "custom_name" - }, - "evaluate": { - "or": [ - { - "condition": { - "param": "custom_name", - "op": "isEmpty" - } - }, - { - "and": [ - { - "condition": { - "param": "custom_name", - "op": "isNotEmpty" - } - }, - { - "condition": { - "param": "annotation", - "op": "isNotEmpty" - } - } - ] - } - ] - } - } - } - ] - } - }, - "appData": { - "nodeId": "id2PZSCTRPRIJ", - "updateUrl": "streams/153651d6-9b88-423c-b01b-861f12d01489/diagrams/153651d6-9b88-423c-b01b-861f12d01489/nodes/id2PZSCTRPRIJ" - }, - "additionalComponents": null -} diff --git a/common-canvas/form/examples/FieldReorder_form.json b/common-canvas/form/examples/FieldReorder_form.json deleted file mode 100644 index c6feb60..0000000 --- a/common-canvas/form/examples/FieldReorder_form.json +++ /dev/null @@ -1,357 +0,0 @@ -{ - "title": { - "key": null, - "ref": null, - "props": { - "id": "dialog.nodePropertiesTitle", - "values": {} - }, - "_owner": null, - "_store": {} - }, - "formData": { - "componentId": "reorder", - "label": "Field Reorder", - "uiItems": [ - { - "itemType": "primaryTabs", - "tabs": [ - { - "text": "Settings", - "group": "basic-settings", - "content": { - "itemType": "panel", - "panel": { - "id": "basic-settings", - "panelType": "general", - "uiItems": [ - { - "itemType": "panel", - "panel": { - "id": "mode-settings", - "panelType": "general", - "uiItems": [ - { - "itemType": "control", - "control": { - "name": "mode", - "label": { - "text": "Mode" - }, - "separateLabel": true, - "controlType": "radioset", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - }, - "values": [ - "Custom", - "Auto" - ], - "valueLabels": [ - "Custom order", - "Automatic sort" - ] - } - } - ] - } - }, - { - "itemType": "panelSelector", - "tabs": [ - { - "text": "Custom.label", - "group": "Custom", - "content": { - "itemType": "control", - "control": { - "name": "fieldOrder", - "separateLabel": true, - "controlType": "structuretable", - "moveableRows": true, - "valueDef": { - "propType": "structure", - "isList": true, - "isMap": false - }, - "subControls": [ - { - "name": "field", - "label": { - "text": "Field" - }, - "visible": true, - "width": 28, - "controlType": "selectcolumn", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - } - }, - { - "name": "field_type", - "label": { - "text": "Type" - }, - "visible": true, - "width": 16, - "controlType": "selectcolumn", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - } - } - ], - "keyIndex": 0, - "defaultRow": [ - "-- All Remaining Fields --", - "" - ] - } - } - }, - { - "text": "Auto.label", - "group": "Auto", - "content": { - "itemType": "panel", - "panel": { - "id": "Auto", - "panelType": "general", - "uiItems": [ - { - "itemType": "control", - "control": { - "name": "sort_by", - "label": { - "text": "Sort by" - }, - "separateLabel": true, - "controlType": "radioset", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - }, - "values": [ - "Name", - "Type", - "Storage" - ], - "valueLabels": [ - "Name", - "Type", - "Storage" - ] - } - }, - { - "itemType": "control", - "control": { - "name": "ascending", - "label": { - "text": "Ascending?" - }, - "separateLabel": false, - "controlType": "checkbox", - "valueDef": { - "propType": "boolean", - "isList": false, - "isMap": false - } - } - } - ] - } - } - } - ], - "dependsOn": "mode" - } - ] - } - } - }, - { - "text": "Annotations", - "group": "annotations", - "content": { - "itemType": "panel", - "panel": { - "id": "annotations", - "panelType": "general", - "uiItems": [ - { - "itemType": "control", - "control": { - "name": "use_custom_name", - "label": { - "text": "Custom name" - }, - "separateLabel": false, - "controlType": "checkbox", - "valueDef": { - "propType": "boolean", - "isList": false, - "isMap": false - } - } - }, - { - "itemType": "control", - "control": { - "name": "custom_name", - "label": { - "text": "" - }, - "separateLabel": true, - "controlType": "textfield", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - } - } - }, - { - "itemType": "control", - "control": { - "name": "annotation", - "label": { - "text": "Annotation" - }, - "separateLabel": true, - "controlType": "textarea", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - } - } - } - ] - } - } - } - ] - } - ], - "buttons": [ - { - "id": "ok", - "text": "Ok", - "isPrimary": true, - "url": "" - }, - { - "id": "cancel", - "text": "Cancel", - "isPrimary": false, - "url": "" - } - ], - "data": { - "currentParameters": { - "annotation": "", - "sort_by": "Name", - "ascending": true, - "use_custom_name": true, - "mode": "Custom", - "custom_name": "", - "fieldOrder": [ - [ - "Na", - "Range" - ], - [ - "-- All Remaining Fields --", - "" - ], - [ - "Sex", - "Discrete" - ] - ] - }, - "datasetMetadata": [ - { - "id": "schema1", - "fields": [ - { - "name": "Age", - "type": "integer", - "metadata": { - "description": "", - "measure": "range", - "modeling_role": "input" - } - }, - { - "name": "Sex", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - }, - { - "name": "BP", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - }, - { - "name": "Cholesterol", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - }, - { - "name": "Na", - "type": "double", - "metadata": { - "description": "", - "measure": "range", - "modeling_role": "input" - } - }, - { - "name": "K", - "type": "double", - "metadata": { - "description": "", - "measure": "range", - "modeling_role": "input" - } - }, - { - "name": "Drug", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - } - ] - } - ] - } - }, - "appData": { - "nodeId": "idUDSKKIJGSU", - "updateUrl": "streams/153651d6-9b88-423c-b01b-861f12d01489/diagrams/153651d6-9b88-423c-b01b-861f12d01489/nodes/idUDSKKIJGSU" - }, - "additionalComponents": null -} diff --git a/common-canvas/form/examples/NeuralNet_form.json b/common-canvas/form/examples/NeuralNet_form.json deleted file mode 100644 index cc47e44..0000000 --- a/common-canvas/form/examples/NeuralNet_form.json +++ /dev/null @@ -1,347 +0,0 @@ -{ - "title": { - "key": null, - "ref": null, - "props": { - "id": "dialog.nodePropertiesTitle", - "values": {} - }, - "_owner": null, - "_store": {} - }, - "formData": { - "componentId": "neuralnetwork", - "label": "Neural Net", - "uiItems": [ - { - "itemType": "primaryTabs", - "tabs": [ - { - "text": "Fields", - "group": "fields-settings", - "content": { - "itemType": "panel", - "panel": { - "id": "fields-settings", - "panelType": "general", - "uiItems": [ - { - "itemType": "panel", - "panel": { - "id": "use-custom", - "panelType": "general", - "uiItems": [ - { - "itemType": "control", - "control": { - "name": "custom_fields", - "label": { - "text": "Use custom fields" - }, - "separateLabel": false, - "controlType": "checkbox", - "valueDef": { - "propType": "boolean", - "isList": false, - "isMap": false - } - } - } - ] - } - }, - { - "itemType": "panel", - "panel": { - "id": "field-allocation", - "panelType": "columnSelection", - "uiItems": [ - { - "itemType": "control", - "control": { - "name": "targets", - "label": { - "text": "Targets" - }, - "separateLabel": true, - "controlType": "columnselect", - "valueDef": { - "propType": "string", - "isList": true, - "isMap": false - } - } - }, - { - "itemType": "control", - "control": { - "name": "inputs", - "label": { - "text": "Inputs" - }, - "separateLabel": true, - "controlType": "columnselect", - "valueDef": { - "propType": "string", - "isList": true, - "isMap": false - } - } - } - ] - } - } - ] - } - } - }, - { - "text": "Build Options", - "group": "build-options", - "content": { - "itemType": "subTabs", - "tabs": [ - { - "text": "Basics", - "group": "basics-settings", - "content": { - "itemType": "panel", - "panel": { - "id": "basics-settings", - "panelType": "general", - "uiItems": [ - { - "itemType": "control", - "control": { - "name": "method", - "label": { - "text": "Neural net type" - }, - "separateLabel": true, - "controlType": "radioset", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - }, - "values": [ - "multilayerPerceptron", - "radialBasisFunction" - ], - "valueLabels": [ - "Multilayer Perceptron (MLP)", - "Radial Basis Function (RBF)" - ] - } - } - ] - } - } - }, - { - "text": "Advanced", - "group": "advanced-settings", - "content": { - "itemType": "panel", - "panel": { - "id": "advanced-settings", - "panelType": "general", - "uiItems": [ - { - "itemType": "control", - "control": { - "name": "overfit_prevention_pct", - "label": { - "text": "Overfit prevention set (%)" - }, - "separateLabel": true, - "controlType": "numberfield", - "valueDef": { - "propType": "double", - "isList": false, - "isMap": false - } - } - } - ] - } - } - } - ] - } - }, - { - "text": "Annotations", - "group": "annotations", - "content": { - "itemType": "panel", - "panel": { - "id": "annotations", - "panelType": "general", - "uiItems": [ - { - "itemType": "control", - "control": { - "name": "use_custom_name", - "label": { - "text": "Custom name" - }, - "separateLabel": false, - "controlType": "checkbox", - "valueDef": { - "propType": "boolean", - "isList": false, - "isMap": false - } - } - }, - { - "itemType": "control", - "control": { - "name": "custom_name", - "label": { - "text": "" - }, - "separateLabel": true, - "controlType": "textfield", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - } - } - }, - { - "itemType": "control", - "control": { - "name": "annotation", - "label": { - "text": "Annotation" - }, - "separateLabel": true, - "controlType": "textarea", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - } - } - } - ] - } - } - } - ] - } - ], - "buttons": [ - { - "id": "ok", - "text": "OK", - "isPrimary": true, - "url": "" - }, - { - "id": "cancel", - "text": "Cancel", - "isPrimary": false, - "url": "" - } - ], - "data": { - "currentParameters": { - "method": "multilayerPerceptron", - "custom_fields": false, - "targets": [], - "annotation": "", - "inputs": [ - "Age", - "Sex", - "BP", - "Cholesterol", - "Na", - "K", - "Drug" - ], - "use_custom_name": false, - "overfit_prevention_pct": 30, - "custom_name": "" - }, - "datasetMetadata": [ - { - "id": "schema1", - "fields": [ - { - "name": "Age", - "type": "integer", - "metadata": { - "description": "", - "measure": "range", - "modeling_role": "input" - } - }, - { - "name": "Sex", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - }, - { - "name": "BP", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - }, - { - "name": "Cholesterol", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - }, - { - "name": "Na", - "type": "double", - "metadata": { - "description": "", - "measure": "range", - "modeling_role": "input" - } - }, - { - "name": "K", - "type": "double", - "metadata": { - "description": "", - "measure": "range", - "modeling_role": "input" - } - }, - { - "name": "Drug", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - } - ] - } - ] - } - }, - "appData": { - "nodeId": "id7XGU98GP86F", - "updateUrl": "streams/153651d6-9b88-423c-b01b-861f12d01489/diagrams/153651d6-9b88-423c-b01b-861f12d01489/nodes/id7XGU98GP86F" - }, - "additionalComponents": null -} diff --git a/common-canvas/form/examples/SelectStorage_form.json b/common-canvas/form/examples/SelectStorage_form.json deleted file mode 100644 index 3b9face..0000000 --- a/common-canvas/form/examples/SelectStorage_form.json +++ /dev/null @@ -1,294 +0,0 @@ -{ - "componentId": "storage", - "label": "Storage", - "editorSize": "large", - "uiItems": [ - { - "itemType": "primaryTabs", - "tabs": [ - { - "text": "Settings", - "group": "basic-settings", - "content": { - "itemType": "panel", - "panel": { - "id": "basic-settings", - "panelType": "general", - "uiItems": [ - { - "itemType": "control", - "control": { - "name": "field_types", - "label": { - "text": "" - }, - "description": { - "text": "Change the type of columns in the active dataset" - }, - "controlType": "structuretable", - "valueDef": { - "propType": "structure", - "isList": false, - "isMap": true, - "defaultValue": [] - }, - "separateLabel": true, - "subControls": [ - { - "name": "field", - "label": { - "text": "Field" - }, - "controlType": "selectcolumn", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - }, - "role": "column", - "filterable": true, - "visible": true, - "width": 16 - }, - { - "name": "override", - "label": { - "text": "Override" - }, - "controlType": "checkbox", - "valueDef": { - "propType": "boolean", - "isList": false, - "isMap": false - }, - "visible": true, - "width": 26, - "editStyle": "inline" - }, - { - "name": "storage", - "label": { - "text": "Storage" - }, - "controlType": "oneofselect", - "valueDef": { - "propType": "string", - "isList": false, - "isMap": false - }, - "role": "enum", - "values": [ - "string", - "integer", - "double", - "date", - "time", - "timestamp", - "password", - "structure" - ], - "valueLabels": [ - "string", - "integer", - "double", - "date", - "time", - "timestamp", - "password", - "structure" - ], - "visible": true, - "width": 26, - "editStyle": "inline", - "dmDefault": "type" - } - ], - "keyIndex": 0, - "defaultRow": [ - null, - null - ], - "noPickColumns": true - } - } - ] - } - } - } - ] - } - ], - "buttons": [ - { - "id": "ok", - "text": "OK", - "isPrimary": true, - "url": "" - }, - { - "id": "cancel", - "text": "Cancel", - "isPrimary": false, - "url": "" - } - ], - "data": { - "currentParameters": { - "field_types": [ - [ - "Age", - true, - "integer" - ], - [ - "Sex", - false, - "string" - ], - [ - "Na", - false, - "double" - ], - [ - "K", - false, - "double" - ], - [ - "Drug", - false, - "string" - ], - [ - "Cp", - false, - "double" - ], - [ - "Returns", - false, - "integer" - ], - [ - "Tag", - false, - "string" - ] - ] - }, - "datasetMetadata": [ - { - "id": "schema1", - "fields": [ - { - "name": "Age", - "type": "integer", - "metadata": { - "description": "", - "measure": "range", - "modeling_role": "input" - } - }, - { - "name": "Sex", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - }, - { - "name": "BP", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - }, - { - "name": "Cholesterol", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - }, - { - "name": "Na", - "type": "double", - "metadata": { - "description": "", - "measure": "range", - "modeling_role": "input" - } - }, - { - "name": "K", - "type": "double", - "metadata": { - "description": "", - "measure": "range", - "modeling_role": "input" - } - }, - { - "name": "Drug", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - }, - { - "name": "Cp", - "type": "double", - "metadata": { - "description": "", - "measure": "range", - "modeling_role": "input" - } - }, - { - "name": "Returns", - "type": "integer", - "metadata": { - "description": "", - "measure": "range", - "modeling_role": "input" - } - }, - { - "name": "Tag", - "type": "string", - "metadata": { - "description": "", - "measure": "discrete", - "modeling_role": "input" - } - } - ] - } - ] - }, - "conditions": [ - { - "enabled": { - "parameter_refs": [ - "field_types[2]" - ], - "evaluate": { - "condition": { - "parameter_ref": "field_types[1]", - "op": "equals", - "value": true - } - } - } - } - ] -} diff --git a/common-canvas/form/form-v1-schema.json b/common-canvas/form/form-v1-schema.json deleted file mode 100644 index 1768f2a..0000000 --- a/common-canvas/form/form-v1-schema.json +++ /dev/null @@ -1,868 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft-04/schema#", - "id": "https://api.dataplatform.ibm.com/schemas/common-canvas/form/form-v1-schema.json#", - "title": "Watson Data Platform Form Schema", - "description": "Form schema for the Watson Data Platform", - "type": "object", - "properties": { - "componentId": { - "description": "The type of the component being edited.", - "type": "string" - }, - "label": { - "description": "The component label.", - "type": "string" - }, - "labelEditable": { - "description": "True if the label can be edited. False if the label should be readonly.", - "type": "boolean", - "default": true - }, - "editorSize": { - "description": "The editor size.", - "enum": [ - "large", - "medium", - "small" - ] - }, - "uiItems": { - "description": "List of UI items.", - "type": "array", - "items": { - "$ref": "#/definitions/ui_item_definition" - } - }, - "buttons": { - "description": "List of buttons that should appear in the UI. Currently ignored.", - "type": "array", - "items": { - "$ref": "#/definitions/button_definition" - } - }, - "conditions": { - "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/operators/conditions-v1-schema.json#conditions" - }, - "data": { - "description": "Additional data such as initial settings and data schema.", - "type": "object", - "$ref": "#/definitions/form_data_definition" - }, - "help": { - "description": "Help information", - "type": "object", - "properties": { - "data": { - "description": "Data passed in the helpClickHandler.", - "type": "object", - "additionalProperties": true - } - }, - "additionalProperties": true - } - }, - "required": [ - "componentId", - "label", - "uiItems", - "data" - ], - "definitions": { - "ui_item_definition": { - "description": "UI item definition that represents a basic element in the UI", - "type": "object", - "properties": { - "id": { - "description": "The panel ID", - "type": "string" - }, - "itemType": { - "description": "The type of UI item.", - "type": "string", - "enum": [ - "control", - "additionalLink", - "staticText", - "hSeparator", - "panel", - "primaryTabs", - "subTabs", - "panelSelector", - "checkboxSelector", - "customPanel", - "action", - "textPanel" - ] - }, - "tabs": { - "description": "List of tab definitions for 'primaryTab' and 'secondaryTab' items.", - "type": "array", - "items": { - "$ref": "#/definitions/editor_tab_definition" - } - }, - "panel": { - "description": "Panel definition for 'panel' items.", - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/control_panel_definition" - }, - { - "$ref": "#/definitions/text_panel_definition" - } - ] - }, - "control": { - "description": "Control definition for 'control' items.", - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/control_definition" - }, - { - "$ref": "#/definitions/sub_control_definition" - } - ] - }, - "text": { - "description": "Text associated with 'additionalLink' or 'staticText'", - "type": "string" - }, - "textType": { - "description": "When set, adds additional styling and icon to 'text'", - "enum": [ - "info" - ] - }, - "secondaryText": { - "description": "Secondary text associated with the sub-panel shown when an 'additionalLink' is clicked.", - "type": "string" - }, - "dependsOn": { - "description": "Specifies a parameter name (usually associated with a boolean or enumerated value) whose control value this item depends on.", - "type": "string" - }, - "insertPanels": { - "description": "Indicates whether panels, contained with a panelSelector, should be inserted between the radio buttons of a radio button set indicated by the dependsOn parameter.", - "type": "boolean" - }, - "action": { - "description": "Action definition for 'action' items.", - "type": "object", - "$ref": "#/definitions/action_definition" - } - }, - "required": [ - "id", - "itemType" - ] - }, - "editor_tab_definition": { - "description": "Defines a tab or sub-tab.", - "type": "object", - "properties": { - "text": { - "description": "The text in the tab", - "type": "string" - }, - "group": { - "description": "The parameter group being displayed in the tab", - "type": "string" - }, - "content": { - "description": "The UI item to be shown.", - "type": "object", - "$ref": "#/definitions/ui_item_definition" - } - }, - "required": [ - "text", - "group", - "uiItem" - ] - }, - "text_panel_definition": { - "description": "Defines a text panel.", - "type": "object", - "properties": { - "id": { - "description": "The panel ID", - "type": "string" - }, - "label": { - "description": "Defines a panel label.", - "type": "object", - "properties": { - "text": { - "description": "The label text.", - "type": "string" - } - } - }, - "description": { - "description": "Defines a panel description.", - "type": "object", - "properties": { - "text": { - "description": "The description text.", - "type": "string" - } - } - } - }, - "required": [ - "id" - ] - }, - "control_panel_definition": { - "description": "Defines a control panel.", - "type": "object", - "properties": { - "id": { - "description": "The panel ID", - "type": "string" - }, - "panelType": { - "description": "The type of panel.", - "type": "string", - "enum": [ - "general", - "columnSelection", - "checkboxPanel", - "custom", - "actionPanel", - "twisty", - "summary" - ] - }, - "uiItems": { - "description": "List of UI items in this panel.", - "type": "array", - "items": { - "$ref": "#/definitions/ui_item_definition" - } - }, - "parameters": { - "description": "List of parameters for the custom panel", - "type": "array", - "items": { - "type": "string" - } - }, - "data": { - "description": "Data passed to customPanel when panelType=custom", - "type": "object", - "additionalProperties": true - }, - "label": { - "description": "Defines a panel label. Used in checkboxPanel", - "type": "object", - "properties": { - "text": { - "description": "The label text.", - "type": "string" - } - } - } - }, - "required": [ - "id", - "panelType", - "uiItems" - ] - }, - "control_definition": { - "description": "Defines a control that is used to edit a parameter.", - "type": "object", - "properties": { - "name": { - "description": "The name of the parameter that can be edited by this control.", - "type": "string" - }, - "label": { - "description": "The control label and any associated shortcuts. This may also be used for accessibility reasons so must be provided even if the control doesn't show the label.", - "type": "object", - "$ref": "#/definitions/control_label_definition" - }, - "labelVisible": { - "description": "Whether the label should be shown. Typically checkboxes don't have a separate label although this can be over-ridden.", - "type": "boolean", - "default": true - }, - "description": { - "description": "Optional description for the control", - "type": "object", - "properties": { - "text": { - "description": "The text to display", - "type": "string" - }, - "placement": { - "description": "Optional placement context", - "enum": [ - "as_tooltip", - "on_panel" - ], - "default": "as_tooltip" - } - }, - "required": [ - "text" - ] - }, - "controlType": { - "description": "The type of control.", - "type": "string", - "enum": [ - "readonly", - "textfield", - "passwordfield", - "textarea", - "expression", - "numberfield", - "spinner", - "checkbox", - "radioset", - "checkboxset", - "toggletext", - "oneofselect", - "someofselect", - "selectcolumn", - "selectcolumns", - "structuretable", - "structureeditor", - "structurelisteditor", - "custom", - "datefield", - "timefield" - ] - }, - "valueDef": { - "description": "The basic metadata about the parameter associated with the control.", - "type": "object", - "$ref": "#/definitions/value_definition" - }, - "role": { - "description": "The additional information about the role as defined by the parameter declaration.", - "type": "string" - }, - "increment": { - "description": "Determines the increment/decrement value for the spinner control only", - "type": "number", - "default": 1 - }, - "charLimit": { - "description": "Control text size limit.", - "type": "integer" - }, - "additionalText": { - "description": "The additional text to be shown close to the control.", - "type": "string" - }, - "orientation": { - "description": "Defines the flow of any sub-controls e.g. radio buttons or checkboxes.", - "type": "string", - "enum": [ - "vertical", - "horizontal" - ] - }, - "values": { - "description": "For enumerated types, this defines the set of valid values.", - "type": "array", - "items": { - "type": "string" - } - }, - "valueLabels": { - "description": "For enumerated types, this defines the set of labels for the valid values. The ordering must be consistent with the order in the 'values' attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "valueIcons": { - "description": "For enumerated types, this defines the set of icons for the valid values. The ordering must be consistent with the order in the 'values' attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "moveableRows": { - "description": "For structure types, determines if rows can be moved up or down in a table", - "type": "boolean" - }, - "row_selection": { - "description": "Determines how many rows can be selected at a time.", - "type": "string", - "enum": [ - "single", - "multiple" - ] - }, - "subControls": { - "description": "For structure types, this defines the control information for sub-parameters. Used to render the table columns and the sub-panel.", - "type": "array", - "items": { - "$ref": "#/definitions/sub_control_definition" - } - }, - "keyIndex": { - "description": "For structure/tabular controls, indicates which column index is the key (-1 indicates no key).", - "type": "integer" - }, - "defaultRow": { - "description": "For structure/tabular controls, specifies the initial values for the new row/structure (e.g. when a '+' button is pressed).", - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/definitions/parameterRef_definition" - }, - { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "array" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - } - }, - "noPickColumns": { - "description": "Suppresses Add/Remove Columns from structure tables residing within columnSelection or columnAllocation panels", - "type": "boolean" - }, - "childItem": { - "description": "The basic metadata about the parameter associated with the control.", - "type": "object", - "$ref": "#/definitions/ui_item_definition" - }, - "editStyle": { - "description": "Editing style of elements in a table", - "type": "string", - "enum": [ - "subpanel", - "inline", - "on_panel" - ] - }, - "summary": { - "description": "Determines if this column values will be shown in the summaryPanel", - "type": "boolean" - }, - "required": { - "description": "True when this parameter must be provided in order to execute.", - "type": "boolean" - }, - "customControlId": { - "description": "Used to determine which custom control to use when controlType=custom.", - "type": "string" - }, - "data": { - "description": "Data passed to custom control when controlType=custom", - "type": "object", - "additionalProperties": true - }, - "dateFormat": { - "description": "A format string such as YYYY-MM-DD which describes the display and entry format for a date field.", - "type": "string" - }, - "timeFormat": { - "description": "A format string such as HH:mm:ss which describes the display and entry format for a time field.", - "type": "string" - }, - "rows": { - "description": "Number of rows to display in tables", - "type": "integer", - "default": 4 - }, - "header": { - "description": "Determines if the table header should be displayed", - "type": "boolean", - "default": true - } - }, - "required": [ - "name", - "label", - "separateLabel", - "controlType", - "valueDef" - ] - }, - "sub_control_definition": { - "description": "Defines a control that is used to edit a parameter within a structure. Note that this differs from a standard control by not supporting structures within a structure. This should be addressed.", - "type": "object", - "properties": { - "name": { - "description": "The name of the parameter that can be edited by this control.", - "type": "string" - }, - "label": { - "description": "The control label and any associated shortcuts.", - "type": "object", - "$ref": "#/definitions/control_label_definition" - }, - "visible": { - "description": "Whether the table showing the structures includes a column for this sub-parameter.", - "type": "boolean" - }, - "width": { - "description": "Suggested width of the column in the table that shows the current value.", - "type": "integer" - }, - "controlType": { - "description": "The type of control.", - "type": "string", - "enum": [ - "readonly", - "textfield", - "passwordfield", - "textarea", - "expression", - "numberfield", - "spinner", - "checkbox", - "radioset", - "checkboxset", - "toggletext", - "oneofselect", - "someofselect", - "selectcolumn", - "selectcolumns", - "custom", - "datefield", - "timefield" - ] - }, - "valueDef": { - "description": "The basic metadata about the parameter associated with the control.", - "type": "object", - "$ref": "#/definitions/value_definition" - }, - "role": { - "description": "The additional information about the role as defined by the parameter declaration.", - "type": "string" - }, - "increment": { - "description": "Determines the increment/decrement value for the spinner control only", - "type": "number", - "default": 1 - }, - "charLimit": { - "description": "Control text size limit.", - "type": "integer" - }, - "additionalText": { - "description": "The additional text to be shown close to the control.", - "type": "string" - }, - "orientation": { - "description": "Defines the flow of any sub-controls e.g. radio buttons or checkboxes.", - "type": "string", - "enum": [ - "vertical", - "horizontal" - ] - }, - "values": { - "description": "For enumerated types, this defines the set of valid values.", - "type": "array", - "items": { - "type": "string" - } - }, - "valueLabels": { - "description": "For enumerated types, this defines the set of labels for the valid values. The ordering must be consistent with the order in the 'values' attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "valueIcons": { - "description": "For enumerated types, this defines the set of icons for the valid values. The ordering must be consistent with the order in the 'values' attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "sortable": { - "description": "Determines if this column values can be sorted into ascending/descending order in a table", - "type": "boolean" - }, - "filterable": { - "description": "Determines if this column values can be filtered so that only rows that match the filter in column values are shown in the table", - "type": "boolean" - }, - "language": { - "description": "The language for the expression editor syntax highlight and autocomplete workds. Applies to expression control type.", - "type": "string", - "enum": [ - "CLEM", - "text/x-hive" - ] - }, - "summary": { - "description": "Determines if this column values will be shown in the summaryPanel", - "type": "boolean" - }, - "customControlId": { - "description": "Used to determine which custom control to use when controlType=custom.", - "type": "string" - }, - "data": { - "description": "Data passed to custom control when controlType=custom", - "type": "object", - "additionalProperties": true - }, - "dateFormat": { - "description": "A format string such as YYYY-MM-DD which describes the display and entry format for a date field.", - "type": "string" - }, - "timeFormat": { - "description": "A format string such as HH:mm:ss which describes the display and entry format for a time field.", - "type": "string" - }, - "generatedValues": { - "description": "Generates values for a column in a 'readonly' parameter.", - "type": "object", - "properties": { - "operation": { - "description": "Currently only 'index' is supported which will auto-increment the integer column value starting at 1. The start value can be configured by setting a startValue.", - "type": "string", - "enum": [ - "index" - ] - }, - "startValue": { - "description": "Optional start value to increment from when the 'type' is 'index'. If the startValue is not set, it will default to 1.", - "type": "integer" - } - }, - "required": [ - "operation" - ] - } - }, - "required": [ - "name", - "label", - "visible", - "width", - "controlType", - "valueDef" - ] - }, - "control_label_definition": { - "description": "Defines a control label.", - "type": "object", - "properties": { - "text": { - "description": "The label text.", - "type": "string" - }, - "number_generator": { - "description": "Adds a number generation link beside the label of this control", - "type": "object", - "properties": { - "label": { - "description": "Link text", - "type": "string" - }, - "range": { - "description": "Number generator range", - "type": "object", - "properties": { - "min": { - "description": "Maximum value for generated numbers", - "type": "number" - } - }, - "required": [ - "min", - "max" - ] - } - }, - "required": [ - "label" - ] - } - }, - "required": [ - "text" - ] - }, - "value_definition": { - "description": "Defines basic value metadata.", - "type": "object", - "properties": { - "propType": { - "description": "The basic property type.", - "type": "string", - "enum": [ - "boolean", - "integer", - "long", - "double", - "string", - "password", - "date", - "structure" - ] - }, - "isList": { - "description": "Whether the value is represented as a list.", - "type": "boolean" - }, - "isMap": { - "description": "Whether the value is represented as a map.", - "type": "boolean" - }, - "defaultValue": { - "description": "Optional default value", - "anyOf": [ - { - "$ref": "#/definitions/parameterRef_definition" - }, - { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "array" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - } - }, - "required": [ - "propType", - "isList", - "isMap" - ] - }, - "parameterRef_definition": { - "description": "Structure for parameter refs", - "type": "object", - "properties": { - "parameterRef": { - "description": "Reference to another parameter.", - "type": "string" - } - }, - "required": [ - "parameterRef" - ] - }, - "action_definition": { - "description": "Defines a action that is used to callback to the application.", - "type": "object", - "properties": { - "name": { - "description": "The name of the action.", - "type": "string" - }, - "label": { - "description": "The action label. Usually the label on a button.", - "type": "object", - "$ref": "#/definitions/control_label_definition" - }, - "actionType": { - "description": "The type of action.", - "type": "string", - "enum": [ - "button" - ] - }, - "data": { - "description": "Data returned when action called", - "type": "object", - "additionalProperties": true - } - }, - "required": [ - "name", - "label", - "actionType" - ] - }, - "button_definition": { - "description": "Defines a button and any associated callback.", - "type": "object", - "properties": { - "id": { - "description": "Button identifier", - "type": "string" - }, - "text": { - "description": "Button label text", - "type": "string" - }, - "isPrimary": { - "description": "Whether the button is the primary/default button.", - "type": "boolean" - }, - "url": { - "description": "The endpoint to be called when the button is pressed.", - "type": "string" - } - }, - "required": [ - "id", - "text", - "isPrimary", - "url" - ] - }, - "form_data_definition": { - "description": "Additional data such as initial settings and input data schema.", - "type": "object", - "properties": { - "currentParameters": { - "description": "Current parameter set upon input. Keys are parameter names, values are their values.", - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "datasetMetadata": { - "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v1-schema.json#" - } - }, - "required": [ - "currentParameters" - ] - } - } -} diff --git a/common-canvas/form/form-v2-schema.json b/common-canvas/form/form-v2-schema.json deleted file mode 100644 index a4847a1..0000000 --- a/common-canvas/form/form-v2-schema.json +++ /dev/null @@ -1,956 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft-04/schema#", - "id": "https://api.dataplatform.ibm.com/schemas/common-canvas/form/form-v2-schema.json#", - "title": "Watson Data Platform Form Schema", - "description": "Form schema for the Watson Data Platform", - "type": "object", - "properties": { - "componentId": { - "description": "The type of the component being edited.", - "type": "string" - }, - "label": { - "description": "The component label.", - "type": "string" - }, - "labelEditable": { - "description": "True if the label can be edited. False if the label should be readonly.", - "type": "boolean", - "default": true - }, - "editorSize": { - "description": "The editor size.", - "enum": [ - "large", - "medium", - "small" - ] - }, - "pixelWidth": { - "description": "Gives more control of editor panel width. The panel is shown at min size if editorSize is small (and max size if editorSize is medium) with a resize button. If min and max are the same no sizing button is displayed.", - "type": "object", - "properties": { - "min": { - "description": "Minimum size in pixels for the right side editor flyout", - "type": "number" - }, - "max": { - "description": "Maximum size in pixels for the right side editor flyout", - "type": "number" - } - } - }, - "uiItems": { - "description": "List of UI items.", - "type": "array", - "items": { - "$ref": "#/definitions/ui_item_definition" - } - }, - "buttons": { - "description": "List of buttons that should appear in the UI. Currently ignored.", - "type": "array", - "items": { - "$ref": "#/definitions/button_definition" - } - }, - "conditions": { - "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/operators/conditions-v2-schema.json#conditions" - }, - "data": { - "description": "Additional data such as initial settings and data schema.", - "type": "object", - "$ref": "#/definitions/form_data_definition" - }, - "help": { - "description": "Help information", - "type": "object", - "properties": { - "data": { - "description": "Data passed in the helpClickHandler.", - "type": "object", - "additionalProperties": true - } - }, - "additionalProperties": true - } - }, - "required": [ - "componentId", - "label", - "uiItems", - "data" - ], - "definitions": { - "ui_item_definition": { - "description": "UI item definition that represents a basic element in the UI", - "type": "object", - "properties": { - "id": { - "description": "The panel ID", - "type": "string" - }, - "itemType": { - "description": "The type of UI item.", - "type": "string", - "enum": [ - "control", - "additionalLink", - "staticText", - "hSeparator", - "panel", - "primaryTabs", - "subTabs", - "panelSelector", - "checkboxSelector", - "customPanel", - "action", - "textPanel" - ] - }, - "tabs": { - "description": "List of tab definitions for 'primaryTab' and 'secondaryTab' items.", - "type": "array", - "items": { - "$ref": "#/definitions/editor_tab_definition" - } - }, - "panel": { - "description": "Panel definition for 'panel' items.", - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/control_panel_definition" - }, - { - "$ref": "#/definitions/text_panel_definition" - } - ] - }, - "control": { - "description": "Control definition for 'control' items.", - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/control_definition" - }, - { - "$ref": "#/definitions/sub_control_definition" - } - ] - }, - "text": { - "description": "Text associated with 'additionalLink' or 'staticText'", - "type": "string" - }, - "textType": { - "description": "When set, adds additional styling and icon to 'text'", - "enum": [ - "info" - ] - }, - "secondaryText": { - "description": "Secondary text associated with the sub-panel shown when an 'additionalLink' is clicked.", - "type": "string" - }, - "dependsOn": { - "description": "Specifies a parameter name (usually associated with a boolean or enumerated value) whose control value this item depends on.", - "type": "string" - }, - "insertPanels": { - "description": "Indicates whether panels, contained with a panelSelector, should be inserted between the radio buttons of a radio button set indicated by the dependsOn parameter.", - "type": "boolean" - }, - "action": { - "description": "Action definition for 'action' items.", - "type": "object", - "$ref": "#/definitions/action_definition" - } - }, - "required": [ - "id", - "itemType" - ] - }, - "editor_tab_definition": { - "description": "Defines a tab or sub-tab.", - "type": "object", - "properties": { - "text": { - "description": "The text in the tab", - "type": "string" - }, - "group": { - "description": "The parameter group being displayed in the tab", - "type": "string" - }, - "content": { - "description": "The UI item to be shown.", - "type": "object", - "$ref": "#/definitions/ui_item_definition" - } - }, - "required": [ - "text", - "group", - "uiItem" - ] - }, - "text_panel_definition": { - "description": "Defines a text panel.", - "type": "object", - "properties": { - "id": { - "description": "The panel ID", - "type": "string" - }, - "label": { - "description": "Defines a panel label.", - "type": "object", - "properties": { - "text": { - "description": "The label text.", - "type": "string" - } - } - }, - "description": { - "description": "Defines a panel description.", - "type": "object", - "properties": { - "text": { - "description": "The description text.", - "type": "string" - } - } - } - }, - "required": [ - "id" - ] - }, - "control_panel_definition": { - "description": "Defines a control panel.", - "type": "object", - "properties": { - "id": { - "description": "The panel ID", - "type": "string" - }, - "panelType": { - "description": "The type of panel.", - "type": "string", - "enum": [ - "general", - "columnSelection", - "columnSelectionRecursive", - "custom", - "summary", - "actionPanel", - "twisty" - ] - }, - "uiItems": { - "description": "List of UI items in this panel.", - "type": "array", - "items": { - "$ref": "#/definitions/ui_item_definition" - } - }, - "parameters": { - "description": "List of parameters for the custom panel", - "type": "array", - "items": { - "type": "string" - } - }, - "data": { - "description": "Data passed to customPanel when panelType=custom", - "type": "object", - "additionalProperties": true - }, - "label": { - "description": "Defines a panel label.", - "type": "object", - "properties": { - "text": { - "description": "The label text.", - "type": "string" - } - } - } - }, - "required": [ - "id", - "panelType", - "uiItems" - ] - }, - "control_definition": { - "description": "Defines a control that is used to edit a parameter.", - "type": "object", - "properties": { - "name": { - "description": "The name of the parameter that can be edited by this control.", - "type": "string" - }, - "label": { - "description": "The control label and any associated shortcuts. This may also be used for accessibility reasons so must be provided even if the control doesn't show the label.", - "type": "object", - "$ref": "#/definitions/control_label_definition" - }, - "labelVisible": { - "description": "Whether the label should be shown. Typically checkboxes don't have a separate label although this can be over-ridden.", - "type": "boolean", - "default": true - }, - "description": { - "description": "Optional description for the control", - "type": "object", - "properties": { - "text": { - "description": "The text to display", - "type": "string" - }, - "placement": { - "description": "Optional placement context", - "enum": [ - "as_tooltip", - "on_panel" - ], - "default": "as_tooltip" - } - }, - "required": [ - "text" - ] - }, - "controlType": { - "description": "The type of control.", - "type": "string", - "enum": [ - "readonly", - "textfield", - "passwordfield", - "textarea", - "expression", - "numberfield", - "spinner", - "checkbox", - "radioset", - "checkboxset", - "toggletext", - "oneofselect", - "someofselect", - "selectcolumn", - "selectcolumns", - "structuretable", - "structureeditor", - "structurelisteditor", - "structureeditor", - "custom", - "datefield", - "timefield", - "timestampfield" - ] - }, - "valueDef": { - "description": "The basic metadata about the parameter associated with the control.", - "type": "object", - "$ref": "#/definitions/value_definition" - }, - "role": { - "description": "The additional information about the role as defined by the parameter declaration.", - "type": "string" - }, - "increment": { - "description": "Determines the increment/decrement value for the spinner control only", - "type": "number", - "default": 1 - }, - "charLimit": { - "description": "Control text size limit.", - "type": "integer" - }, - "additionalText": { - "description": "The additional text to be shown close to the control.", - "type": "string" - }, - "orientation": { - "description": "Defines the flow of any sub-controls e.g. radio buttons or checkboxes.", - "type": "string", - "enum": [ - "vertical", - "horizontal" - ] - }, - "values": { - "description": "For enumerated types, this defines the set of valid values.", - "type": "array", - "items": { - "type": "string" - } - }, - "valueLabels": { - "description": "For enumerated types, this defines the set of labels for the valid values. The ordering must be consistent with the order in the 'values' attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "valueIcons": { - "description": "For enumerated types, this defines the set of icons for the valid values. The ordering must be consistent with the order in the 'values' attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "moveableRows": { - "description": "For structure types, determines if rows can be moved up or down in a table", - "type": "boolean" - }, - "row_selection": { - "description": "Determines how many rows can be selected at a time. 'multiple-edit': select multiple rows and allow the editing of column values for all selected rows.", - "type": "string", - "enum": [ - "single", - "multiple", - "multiple-edit" - ] - }, - "subControls": { - "description": "For structure types, this defines the control information for sub-parameters. Used to render the table columns and the sub-panel.", - "type": "array", - "items": { - "$ref": "#/definitions/sub_control_definition" - } - }, - "keyIndex": { - "description": "For structure/tabular controls, indicates which column index is the key (-1 indicates no key).", - "type": "integer" - }, - "defaultRow": { - "description": "For structure/tabular controls, specifies the initial values for the new row/structure (e.g. when a '+' button is pressed).", - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/definitions/parameterRef_definition" - }, - { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "array" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - } - }, - "noPickColumns": { - "description": "Suppresses Add/Remove Columns from structure tables residing within columnSelection or columnAllocation panels", - "type": "boolean" - }, - "childItem": { - "description": "The basic metadata about the parameter associated with the control.", - "type": "object", - "$ref": "#/definitions/ui_item_definition" - }, - "editStyle": { - "description": "Editing style of elements in a table", - "type": "string", - "enum": [ - "subpanel", - "inline", - "on_panel" - ] - }, - "summary": { - "description": "Determines if this column values will be shown in the summaryPanel", - "type": "boolean" - }, - "required": { - "description": "True when this parameter must be provided in order to execute.", - "type": "boolean" - }, - "customControlId": { - "description": "Used to determine which custom control to use when controlType=custom.", - "type": "string" - }, - "data": { - "description": "Data passed to custom control when controlType=custom", - "type": "object", - "additionalProperties": true - }, - "dateFormat": { - "description": "A format string such as YYYY-MM-DD which describes the display and entry format for a date field.", - "type": "string" - }, - "timeFormat": { - "description": "A format string such as HH:mm:ss which describes the display and entry format for a time field.", - "type": "string" - }, - "rows": { - "description": "Number of rows to display in tables", - "type": "integer", - "default": 4 - }, - "header": { - "description": "Determines if the table header should be displayed", - "type": "boolean", - "default": true - }, - "dmDefault": { - "description": "Used within complex structures containing 'column' key_definition fields. This associates the subControl parameter with a field attribute in the current record schema.", - "type": "boolean", - "default": false - }, - "dmImage": { - "description": "This can be set to display an icon of the corresponding dm type in the `role`:`column' field of a table.", - "type": "string" - }, - "includeAllFields": { - "description": "Set to true to include all fields in the control at all times", - "type": "boolean", - "default": false - }, - "layout": { - "description": "Array of rows containing structure element names", - "type": "array", - "items": { - "description": "A single row of structure parameter names for laying out horizontally", - "type": "array", - "items": { - "description": "A parameter name within the current structure", - "type": "string" - } - } - } - }, - "required": [ - "name", - "label", - "separateLabel", - "controlType", - "valueDef" - ] - }, - "sub_control_definition": { - "description": "Defines a control that is used to edit a parameter within a structure. Note that this differs from a standard control by not supporting structures within a structure. This should be addressed.", - "type": "object", - "properties": { - "name": { - "description": "The name of the parameter that can be edited by this control.", - "type": "string" - }, - "label": { - "description": "The control label and any associated shortcuts.", - "type": "object", - "$ref": "#/definitions/control_label_definition" - }, - "visible": { - "description": "Whether the table showing the structures includes a column for this sub-parameter.", - "type": "boolean" - }, - "dmImage": { - "description": "This can be set to display an icon of the corresponding dm type in the `role`:`column' field of a table.", - "type": "string" - }, - "width": { - "description": "Suggested width of the column in the table that shows the current value.", - "type": "integer" - }, - "controlType": { - "description": "The type of control.", - "type": "string", - "enum": [ - "readonly", - "textfield", - "passwordfield", - "textarea", - "expression", - "numberfield", - "spinner", - "checkbox", - "radioset", - "checkboxset", - "toggletext", - "oneofselect", - "someofselect", - "selectcolumn", - "selectcolumns", - "custom", - "datefield", - "timefield" - ] - }, - "valueDef": { - "description": "The basic metadata about the parameter associated with the control.", - "type": "object", - "$ref": "#/definitions/value_definition" - }, - "role": { - "description": "The additional information about the role as defined by the parameter declaration.", - "type": "string" - }, - "increment": { - "description": "Determines the increment/decrement value for the spinner control only", - "type": "number", - "default": 1 - }, - "charLimit": { - "description": "Control text size limit.", - "type": "integer" - }, - "displayChars": { - "description": "Limits the number of characters displayed for a text field in a column in a table. The text will have an ellipsis appended at this limit.", - "type": "integer", - "default": 64 - }, - "additionalText": { - "description": "The additional text to be shown close to the control.", - "type": "string" - }, - "orientation": { - "description": "Defines the flow of any sub-controls e.g. radio buttons or checkboxes.", - "type": "string", - "enum": [ - "vertical", - "horizontal" - ] - }, - "values": { - "description": "For enumerated types, this defines the set of valid values.", - "type": "array", - "items": { - "type": "string" - } - }, - "valueLabels": { - "description": "For enumerated types, this defines the set of labels for the valid values. The ordering must be consistent with the order in the 'values' attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "valueIcons": { - "description": "For enumerated types, this defines the set of icons for the valid values. The ordering must be consistent with the order in the 'values' attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "sortable": { - "description": "Determines if this column values can be sorted into ascending/descending order in a table", - "type": "boolean" - }, - "filterable": { - "description": "Determines if this column values can be filtered so that only rows that match the filter in column values are shown in the table", - "type": "boolean" - }, - "language": { - "description": "The language for the expression editor syntax highlight and autocomplete workds. Applies to expression control type.", - "type": "string", - "enum": [ - "CLEM", - "text/x-hive", - "text/x-rsrc", - "text/x-python" - ] - }, - "summary": { - "description": "Determines if this column values will be shown in the summaryPanel", - "type": "boolean" - }, - "customControlId": { - "description": "Used to determine which custom control to use when controlType=custom.", - "type": "string" - }, - "data": { - "description": "Data passed to custom control when controlType=custom", - "type": "object", - "additionalProperties": true - }, - "dateFormat": { - "description": "A format string such as YYYY-MM-DD which describes the display and entry format for a date field.", - "type": "string" - }, - "timeFormat": { - "description": "A format string such as HH:mm:ss which describes the display and entry format for a time field.", - "type": "string" - } - }, - "required": [ - "name", - "label", - "visible", - "width", - "controlType", - "valueDef" - ] - }, - "control_label_definition": { - "description": "Defines a control label.", - "type": "object", - "properties": { - "text": { - "description": "The label text.", - "type": "string" - }, - "number_generator": { - "description": "Adds a number generation link beside the label of this control", - "type": "object", - "properties": { - "label": { - "description": "Link text", - "type": "string" - }, - "range": { - "description": "Number generator range", - "type": "object", - "properties": { - "min": { - "description": "Maximum value for generated numbers", - "type": "number" - } - }, - "required": [ - "min", - "max" - ] - } - }, - "required": [ - "label" - ] - } - }, - "required": [ - "text" - ] - }, - "value_definition": { - "description": "Defines basic value metadata.", - "type": "object", - "properties": { - "propType": { - "description": "The basic property type.", - "type": "string", - "enum": [ - "boolean", - "integer", - "long", - "double", - "string", - "password", - "date", - "structure" - ] - }, - "isList": { - "description": "Whether the value is represented as a list.", - "type": "boolean" - }, - "isMap": { - "description": "Whether the value is represented as a map.", - "type": "boolean" - }, - "defaultValue": { - "description": "Optional default value", - "anyOf": [ - { - "$ref": "#/definitions/parameterRef_definition" - }, - { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "array" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - } - }, - "required": [ - "propType", - "isList", - "isMap" - ] - }, - "parameterRef_definition": { - "description": "Structure for parameter refs", - "type": "object", - "properties": { - "parameterRef": { - "description": "Reference to another parameter.", - "type": "string" - } - }, - "required": [ - "parameterRef" - ] - }, - "action_definition": { - "description": "Defines a action that is used to callback to the application.", - "type": "object", - "properties": { - "name": { - "description": "The name of the action.", - "type": "string" - }, - "label": { - "description": "The action label. Usually the label on a button.", - "type": "object", - "$ref": "#/definitions/control_label_definition" - }, - "description": { - "description": "Defines a action description. Used for tooltip.", - "type": "object", - "properties": { - "text": { - "description": "The description text.", - "type": "string" - } - } - }, - "actionType": { - "description": "The type of action.", - "type": "string", - "enum": [ - "button", - "image" - ] - }, - "image": { - "description": "Properties for how the image will look. Use when control=image.", - "type": "object", - "properties": { - "url": { - "description": "image url to be used for action", - "type": "string" - }, - "placement": { - "description": "placement of the action image", - "enum": [ - "right", - "left" - ] - }, - "size": { - "description": "pixel size of the image.", - "type": "object", - "properties": { - "height": { - "description": "image height in pixels", - "type": "number" - }, - "width": { - "description": "image width in pixels", - "type": "number" - } - } - } - } - }, - "data": { - "description": "Data returned when action called", - "type": "object", - "additionalProperties": true - } - }, - "required": [ - "name", - "label", - "actionType" - ] - }, - "button_definition": { - "description": "Defines a button and any associated callback.", - "type": "object", - "properties": { - "id": { - "description": "Button identifier", - "type": "string" - }, - "text": { - "description": "Button label text", - "type": "string" - }, - "isPrimary": { - "description": "Whether the button is the primary/default button.", - "type": "boolean" - }, - "url": { - "description": "The endpoint to be called when the button is pressed.", - "type": "string" - } - }, - "required": [ - "id", - "text", - "isPrimary", - "url" - ] - }, - "form_data_definition": { - "description": "Additional data such as initial settings and input data schema.", - "type": "object", - "properties": { - "currentParameters": { - "description": "Current parameter set upon input. Keys are parameter names, values are their values.", - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "datasetMetadata": { - "oneOf": [ - { - "description": "A single datarecord object. Deprecated.", - "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v2-schema.json#" - }, - { - "description": "An array of datarecord objects", - "type": "array", - "items": { - "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v2-schema.json#" - } - } - ] - } - }, - "required": [ - "currentParameters" - ] - } - } -} diff --git a/common-canvas/form/form-v3-schema.json b/common-canvas/form/form-v3-schema.json deleted file mode 100644 index 29e88af..0000000 --- a/common-canvas/form/form-v3-schema.json +++ /dev/null @@ -1,957 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft-04/schema#", - "id": "https://api.dataplatform.ibm.com/schemas/common-canvas/form/form-v3-schema.json#", - "title": "Watson Data Platform Form Schema", - "description": "Form schema for the Watson Data Platform", - "type": "object", - "properties": { - "componentId": { - "description": "The type of the component being edited.", - "type": "string" - }, - "label": { - "description": "The component label.", - "type": "string" - }, - "labelEditable": { - "description": "True if the label can be edited. False if the label should be readonly.", - "type": "boolean", - "default": true - }, - "editorSize": { - "description": "The editor size.", - "enum": [ - "large", - "medium", - "small" - ] - }, - "pixelWidth": { - "description": "Gives more control of editor panel width. The panel is shown at min size if editorSize is small (and max size if editorSize is medium) with a resize button. If min and max are the same no sizing button is displayed.", - "type": "object", - "properties": { - "min": { - "description": "Minimum size in pixels for the right side editor flyout", - "type": "number" - }, - "max": { - "description": "Maximum size in pixels for the right side editor flyout", - "type": "number" - } - } - }, - "uiItems": { - "description": "List of UI items.", - "type": "array", - "items": { - "$ref": "#/definitions/ui_item_definition" - } - }, - "buttons": { - "description": "List of buttons that should appear in the UI. Currently ignored.", - "type": "array", - "items": { - "$ref": "#/definitions/button_definition" - } - }, - "conditions": { - "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/operators/conditions-v3-schema.json#conditions" - }, - "data": { - "description": "Additional data such as initial settings and data schema.", - "type": "object", - "$ref": "#/definitions/form_data_definition" - }, - "help": { - "description": "Help information", - "type": "object", - "properties": { - "data": { - "description": "Data passed in the helpClickHandler.", - "type": "object", - "additionalProperties": true - } - }, - "additionalProperties": true - } - }, - "required": [ - "componentId", - "label", - "uiItems", - "data" - ], - "definitions": { - "ui_item_definition": { - "description": "UI item definition that represents a basic element in the UI", - "type": "object", - "properties": { - "id": { - "description": "The panel ID", - "type": "string" - }, - "itemType": { - "description": "The type of UI item.", - "type": "string", - "enum": [ - "control", - "additionalLink", - "staticText", - "hSeparator", - "panel", - "primaryTabs", - "subTabs", - "panelSelector", - "checkboxSelector", - "customPanel", - "action", - "textPanel" - ] - }, - "tabs": { - "description": "List of tab definitions for 'primaryTab' and 'secondaryTab' items.", - "type": "array", - "items": { - "$ref": "#/definitions/editor_tab_definition" - } - }, - "panel": { - "description": "Panel definition for 'panel' items.", - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/control_panel_definition" - }, - { - "$ref": "#/definitions/text_panel_definition" - } - ] - }, - "control": { - "description": "Control definition for 'control' items.", - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/control_definition" - }, - { - "$ref": "#/definitions/sub_control_definition" - } - ] - }, - "text": { - "description": "Text associated with 'additionalLink' or 'staticText'", - "type": "string" - }, - "textType": { - "description": "When set, adds additional styling and icon to 'text'", - "enum": [ - "info" - ] - }, - "secondaryText": { - "description": "Secondary text associated with the sub-panel shown when an 'additionalLink' is clicked.", - "type": "string" - }, - "dependsOn": { - "description": "Specifies a parameter name (usually associated with a boolean or enumerated value) whose control value this item depends on.", - "type": "string" - }, - "insertPanels": { - "description": "Indicates whether panels, contained with a panelSelector, should be inserted between the radio buttons of a radio button set indicated by the dependsOn parameter.", - "type": "boolean" - }, - "action": { - "description": "Action definition for 'action' items.", - "type": "object", - "$ref": "#/definitions/action_definition" - } - }, - "required": [ - "id", - "itemType" - ] - }, - "editor_tab_definition": { - "description": "Defines a tab or sub-tab.", - "type": "object", - "properties": { - "text": { - "description": "The text in the tab", - "type": "string" - }, - "group": { - "description": "The parameter group being displayed in the tab", - "type": "string" - }, - "content": { - "description": "The UI item to be shown.", - "type": "object", - "$ref": "#/definitions/ui_item_definition" - } - }, - "required": [ - "text", - "group", - "uiItem" - ] - }, - "text_panel_definition": { - "description": "Defines a text panel.", - "type": "object", - "properties": { - "id": { - "description": "The panel ID", - "type": "string" - }, - "label": { - "description": "Defines a panel label.", - "type": "object", - "properties": { - "text": { - "description": "The label text.", - "type": "string" - } - } - }, - "description": { - "description": "Defines a panel description.", - "type": "object", - "properties": { - "text": { - "description": "The description text.", - "type": "string" - } - } - } - }, - "required": [ - "id" - ] - }, - "control_panel_definition": { - "description": "Defines a control panel.", - "type": "object", - "properties": { - "id": { - "description": "The panel ID", - "type": "string" - }, - "panelType": { - "description": "The type of panel.", - "type": "string", - "enum": [ - "general", - "columnSelection", - "columnSelectionRecursive", - "custom", - "summary", - "actionPanel", - "twisty" - ] - }, - "uiItems": { - "description": "List of UI items in this panel.", - "type": "array", - "items": { - "$ref": "#/definitions/ui_item_definition" - } - }, - "parameters": { - "description": "List of parameters for the custom panel", - "type": "array", - "items": { - "type": "string" - } - }, - "data": { - "description": "Data passed to customPanel when panelType=custom", - "type": "object", - "additionalProperties": true - }, - "label": { - "description": "Defines a panel label.", - "type": "object", - "properties": { - "text": { - "description": "The label text.", - "type": "string" - } - } - } - }, - "required": [ - "id", - "panelType", - "uiItems" - ] - }, - "control_definition": { - "description": "Defines a control that is used to edit a parameter.", - "type": "object", - "properties": { - "name": { - "description": "The name of the parameter that can be edited by this control.", - "type": "string" - }, - "label": { - "description": "The control label and any associated shortcuts. This may also be used for accessibility reasons so must be provided even if the control doesn't show the label.", - "type": "object", - "$ref": "#/definitions/control_label_definition" - }, - "labelVisible": { - "description": "Whether the label should be shown. Typically checkboxes don't have a separate label although this can be over-ridden.", - "type": "boolean", - "default": true - }, - "description": { - "description": "Optional description for the control", - "type": "object", - "properties": { - "text": { - "description": "The text to display", - "type": "string" - }, - "placement": { - "description": "Optional placement context", - "enum": [ - "as_tooltip", - "on_panel" - ], - "default": "as_tooltip" - } - }, - "required": [ - "text" - ] - }, - "controlType": { - "description": "The type of control.", - "type": "string", - "enum": [ - "readonly", - "textfield", - "passwordfield", - "textarea", - "list", - "expression", - "numberfield", - "spinner", - "checkbox", - "radioset", - "checkboxset", - "toggletext", - "oneofselect", - "someofselect", - "selectcolumn", - "selectcolumns", - "structuretable", - "structureeditor", - "structurelisteditor", - "structureeditor", - "custom", - "datefield", - "timefield", - "timestampfield" - ] - }, - "valueDef": { - "description": "The basic metadata about the parameter associated with the control.", - "type": "object", - "$ref": "#/definitions/value_definition" - }, - "role": { - "description": "The additional information about the role as defined by the parameter declaration.", - "type": "string" - }, - "increment": { - "description": "Determines the increment/decrement value for the spinner control only", - "type": "number", - "default": 1 - }, - "charLimit": { - "description": "Control text size limit.", - "type": "integer" - }, - "additionalText": { - "description": "The additional text to be shown close to the control.", - "type": "string" - }, - "orientation": { - "description": "Defines the flow of any sub-controls e.g. radio buttons or checkboxes.", - "type": "string", - "enum": [ - "vertical", - "horizontal" - ] - }, - "values": { - "description": "For enumerated types, this defines the set of valid values.", - "type": "array", - "items": { - "type": "string" - } - }, - "valueLabels": { - "description": "For enumerated types, this defines the set of labels for the valid values. The ordering must be consistent with the order in the 'values' attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "valueIcons": { - "description": "For enumerated types, this defines the set of icons for the valid values. The ordering must be consistent with the order in the 'values' attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "moveableRows": { - "description": "For structure types, determines if rows can be moved up or down in a table", - "type": "boolean" - }, - "row_selection": { - "description": "Determines how many rows can be selected at a time. 'multiple-edit': select multiple rows and allow the editing of column values for all selected rows.", - "type": "string", - "enum": [ - "single", - "multiple", - "multiple-edit" - ] - }, - "subControls": { - "description": "For structure types, this defines the control information for sub-parameters. Used to render the table columns and the sub-panel.", - "type": "array", - "items": { - "$ref": "#/definitions/sub_control_definition" - } - }, - "keyIndex": { - "description": "For structure/tabular controls, indicates which column index is the key (-1 indicates no key).", - "type": "integer" - }, - "defaultRow": { - "description": "For structure/tabular controls, specifies the initial values for the new row/structure (e.g. when a '+' button is pressed).", - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/definitions/parameterRef_definition" - }, - { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "array" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - } - }, - "noPickColumns": { - "description": "Suppresses Add/Remove Columns from structure tables residing within columnSelection or columnAllocation panels", - "type": "boolean" - }, - "childItem": { - "description": "The basic metadata about the parameter associated with the control.", - "type": "object", - "$ref": "#/definitions/ui_item_definition" - }, - "editStyle": { - "description": "Editing style of elements in a table", - "type": "string", - "enum": [ - "subpanel", - "inline", - "on_panel" - ] - }, - "summary": { - "description": "Determines if this column values will be shown in the summaryPanel", - "type": "boolean" - }, - "required": { - "description": "True when this parameter must be provided in order to execute.", - "type": "boolean" - }, - "customControlId": { - "description": "Used to determine which custom control to use when controlType=custom.", - "type": "string" - }, - "data": { - "description": "Data passed to custom control when controlType=custom", - "type": "object", - "additionalProperties": true - }, - "dateFormat": { - "description": "A format string such as YYYY-MM-DD which describes the display and entry format for a date field.", - "type": "string" - }, - "timeFormat": { - "description": "A format string such as HH:mm:ss which describes the display and entry format for a time field.", - "type": "string" - }, - "rows": { - "description": "Number of rows to display in tables", - "type": "integer", - "default": 4 - }, - "header": { - "description": "Determines if the table header should be displayed", - "type": "boolean", - "default": true - }, - "dmDefault": { - "description": "Used within complex structures containing 'column' key_definition fields. This associates the subControl parameter with a field attribute in the current record schema.", - "type": "boolean", - "default": false - }, - "dmImage": { - "description": "This can be set to display an icon of the corresponding dm type in the `role`:`column' field of a table.", - "type": "string" - }, - "includeAllFields": { - "description": "Set to true to include all fields in the control at all times", - "type": "boolean", - "default": false - }, - "layout": { - "description": "Array of rows containing structure element names", - "type": "array", - "items": { - "description": "A single row of structure parameter names for laying out horizontally", - "type": "array", - "items": { - "description": "A parameter name within the current structure", - "type": "string" - } - } - } - }, - "required": [ - "name", - "label", - "separateLabel", - "controlType", - "valueDef" - ] - }, - "sub_control_definition": { - "description": "Defines a control that is used to edit a parameter within a structure. Note that this differs from a standard control by not supporting structures within a structure. This should be addressed.", - "type": "object", - "properties": { - "name": { - "description": "The name of the parameter that can be edited by this control.", - "type": "string" - }, - "label": { - "description": "The control label and any associated shortcuts.", - "type": "object", - "$ref": "#/definitions/control_label_definition" - }, - "visible": { - "description": "Whether the table showing the structures includes a column for this sub-parameter.", - "type": "boolean" - }, - "dmImage": { - "description": "This can be set to display an icon of the corresponding dm type in the `role`:`column' field of a table.", - "type": "string" - }, - "width": { - "description": "Suggested width of the column in the table that shows the current value.", - "type": "integer" - }, - "controlType": { - "description": "The type of control.", - "type": "string", - "enum": [ - "readonly", - "textfield", - "passwordfield", - "textarea", - "expression", - "numberfield", - "spinner", - "checkbox", - "radioset", - "checkboxset", - "toggletext", - "oneofselect", - "someofselect", - "selectcolumn", - "selectcolumns", - "custom", - "datefield", - "timefield" - ] - }, - "valueDef": { - "description": "The basic metadata about the parameter associated with the control.", - "type": "object", - "$ref": "#/definitions/value_definition" - }, - "role": { - "description": "The additional information about the role as defined by the parameter declaration.", - "type": "string" - }, - "increment": { - "description": "Determines the increment/decrement value for the spinner control only", - "type": "number", - "default": 1 - }, - "charLimit": { - "description": "Control text size limit.", - "type": "integer" - }, - "displayChars": { - "description": "Limits the number of characters displayed for a text field in a column in a table. The text will have an ellipsis appended at this limit.", - "type": "integer", - "default": 64 - }, - "additionalText": { - "description": "The additional text to be shown close to the control.", - "type": "string" - }, - "orientation": { - "description": "Defines the flow of any sub-controls e.g. radio buttons or checkboxes.", - "type": "string", - "enum": [ - "vertical", - "horizontal" - ] - }, - "values": { - "description": "For enumerated types, this defines the set of valid values.", - "type": "array", - "items": { - "type": "string" - } - }, - "valueLabels": { - "description": "For enumerated types, this defines the set of labels for the valid values. The ordering must be consistent with the order in the 'values' attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "valueIcons": { - "description": "For enumerated types, this defines the set of icons for the valid values. The ordering must be consistent with the order in the 'values' attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "sortable": { - "description": "Determines if this column values can be sorted into ascending/descending order in a table", - "type": "boolean" - }, - "filterable": { - "description": "Determines if this column values can be filtered so that only rows that match the filter in column values are shown in the table", - "type": "boolean" - }, - "language": { - "description": "The language for the expression editor syntax highlight and autocomplete workds. Applies to expression control type.", - "type": "string", - "enum": [ - "CLEM", - "text/x-hive", - "text/x-rsrc", - "text/x-python" - ] - }, - "summary": { - "description": "Determines if this column values will be shown in the summaryPanel", - "type": "boolean" - }, - "customControlId": { - "description": "Used to determine which custom control to use when controlType=custom.", - "type": "string" - }, - "data": { - "description": "Data passed to custom control when controlType=custom", - "type": "object", - "additionalProperties": true - }, - "dateFormat": { - "description": "A format string such as YYYY-MM-DD which describes the display and entry format for a date field.", - "type": "string" - }, - "timeFormat": { - "description": "A format string such as HH:mm:ss which describes the display and entry format for a time field.", - "type": "string" - } - }, - "required": [ - "name", - "label", - "visible", - "width", - "controlType", - "valueDef" - ] - }, - "control_label_definition": { - "description": "Defines a control label.", - "type": "object", - "properties": { - "text": { - "description": "The label text.", - "type": "string" - }, - "number_generator": { - "description": "Adds a number generation link beside the label of this control", - "type": "object", - "properties": { - "label": { - "description": "Link text", - "type": "string" - }, - "range": { - "description": "Number generator range", - "type": "object", - "properties": { - "min": { - "description": "Maximum value for generated numbers", - "type": "number" - } - }, - "required": [ - "min", - "max" - ] - } - }, - "required": [ - "label" - ] - } - }, - "required": [ - "text" - ] - }, - "value_definition": { - "description": "Defines basic value metadata.", - "type": "object", - "properties": { - "propType": { - "description": "The basic property type.", - "type": "string", - "enum": [ - "boolean", - "integer", - "long", - "double", - "string", - "password", - "date", - "structure" - ] - }, - "isList": { - "description": "Whether the value is represented as a list.", - "type": "boolean" - }, - "isMap": { - "description": "Whether the value is represented as a map.", - "type": "boolean" - }, - "defaultValue": { - "description": "Optional default value", - "anyOf": [ - { - "$ref": "#/definitions/parameterRef_definition" - }, - { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "array" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - } - }, - "required": [ - "propType", - "isList", - "isMap" - ] - }, - "parameterRef_definition": { - "description": "Structure for parameter refs", - "type": "object", - "properties": { - "parameterRef": { - "description": "Reference to another parameter.", - "type": "string" - } - }, - "required": [ - "parameterRef" - ] - }, - "action_definition": { - "description": "Defines a action that is used to callback to the application.", - "type": "object", - "properties": { - "name": { - "description": "The name of the action.", - "type": "string" - }, - "label": { - "description": "The action label. Usually the label on a button.", - "type": "object", - "$ref": "#/definitions/control_label_definition" - }, - "description": { - "description": "Defines a action description. Used for tooltip.", - "type": "object", - "properties": { - "text": { - "description": "The description text.", - "type": "string" - } - } - }, - "actionType": { - "description": "The type of action.", - "type": "string", - "enum": [ - "button", - "image" - ] - }, - "image": { - "description": "Properties for how the image will look. Use when control=image.", - "type": "object", - "properties": { - "url": { - "description": "image url to be used for action", - "type": "string" - }, - "placement": { - "description": "placement of the action image", - "enum": [ - "right", - "left" - ] - }, - "size": { - "description": "pixel size of the image.", - "type": "object", - "properties": { - "height": { - "description": "image height in pixels", - "type": "number" - }, - "width": { - "description": "image width in pixels", - "type": "number" - } - } - } - } - }, - "data": { - "description": "Data returned when action called", - "type": "object", - "additionalProperties": true - } - }, - "required": [ - "name", - "label", - "actionType" - ] - }, - "button_definition": { - "description": "Defines a button and any associated callback.", - "type": "object", - "properties": { - "id": { - "description": "Button identifier", - "type": "string" - }, - "text": { - "description": "Button label text", - "type": "string" - }, - "isPrimary": { - "description": "Whether the button is the primary/default button.", - "type": "boolean" - }, - "url": { - "description": "The endpoint to be called when the button is pressed.", - "type": "string" - } - }, - "required": [ - "id", - "text", - "isPrimary", - "url" - ] - }, - "form_data_definition": { - "description": "Additional data such as initial settings and input data schema.", - "type": "object", - "properties": { - "currentParameters": { - "description": "Current parameter set upon input. Keys are parameter names, values are their values.", - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "datasetMetadata": { - "oneOf": [ - { - "description": "A single datarecord object. Deprecated.", - "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v3-schema.json#" - }, - { - "description": "An array of datarecord objects", - "type": "array", - "items": { - "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v3-schema.json#" - } - } - ] - } - }, - "required": [ - "currentParameters" - ] - } - } -} diff --git a/common-canvas/form/form-v4-schema.json b/common-canvas/form/form-v4-schema.json deleted file mode 100644 index a162007..0000000 --- a/common-canvas/form/form-v4-schema.json +++ /dev/null @@ -1,848 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft-04/schema#", - "id": "https://api.dataplatform.ibm.com/schemas/common-canvas/form/form-v3-schema.json#", - "title": "Watson Data Platform Form Schema", - "description": "Form schema for the Watson Data Platform", - "type": "object", - "properties": { - "componentId": { - "description": "The type of the component being edited.", - "type": "string" - }, - "label": { - "description": "The component label.", - "type": "string" - }, - "labelEditable": { - "description": "True if the label can be edited. False if the label should be readonly.", - "type": "boolean", - "default": true - }, - "editorSize": { - "description": "The editor size.", - "enum": [ - "large", - "medium", - "small" - ] - }, - "pixelWidth": { - "description": "Gives more control of editor panel width. The panel is shown at min size if editorSize is small (and max size if editorSize is medium) with a resize button. If min and max are the same no sizing button is displayed.", - "type": "object", - "properties": { - "min": { - "description": "Minimum size in pixels for the right side editor flyout", - "type": "number" - }, - "max": { - "description": "Maximum size in pixels for the right side editor flyout", - "type": "number" - } - } - }, - "uiItems": { - "description": "List of UI items.", - "type": "array", - "items": { - "$ref": "#/definitions/ui_item_definition" - } - }, - "buttons": { - "description": "List of buttons that should appear in the UI. Currently ignored.", - "type": "array", - "items": { - "$ref": "#/definitions/button_definition" - } - }, - "conditions": { - "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/operators/conditions-v3-schema.json#conditions" - }, - "data": { - "description": "Additional data such as initial settings and data schema.", - "type": "object", - "$ref": "#/definitions/form_data_definition" - }, - "help": { - "description": "Help information", - "type": "object", - "properties": { - "data": { - "description": "Data passed in the helpClickHandler.", - "type": "object", - "additionalProperties": true - } - }, - "additionalProperties": true - }, - "icon": { - "description": "URL to heading icon", - "type": "string" - }, - "heading": { - "description": "The component heading", - "type": "string" - } - }, - "required": [ - "componentId", - "label", - "uiItems", - "data" - ], - "definitions": { - "ui_item_definition": { - "description": "UI item definition that represents a basic element in the UI", - "type": "object", - "properties": { - "id": { - "description": "The panel ID", - "type": "string" - }, - "itemType": { - "description": "The type of UI item.", - "type": "string", - "enum": [ - "control", - "additionalLink", - "staticText", - "hSeparator", - "panel", - "primaryTabs", - "subTabs", - "panelSelector", - "checkboxSelector", - "customPanel", - "action", - "textPanel" - ] - }, - "tabs": { - "description": "List of tab definitions for 'primaryTab' and 'secondaryTab' items.", - "type": "array", - "items": { - "$ref": "#/definitions/editor_tab_definition" - } - }, - "panel": { - "description": "Panel definition for 'panel' items.", - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/control_panel_definition" - }, - { - "$ref": "#/definitions/text_panel_definition" - } - ] - }, - "control": { - "description": "Control definition for 'control' items.", - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/control_definition" - } - ] - }, - "text": { - "description": "Text associated with 'additionalLink' or 'staticText'", - "type": "string" - }, - "textType": { - "description": "When set, adds additional styling and icon to 'text'", - "enum": [ - "info" - ] - }, - "secondaryText": { - "description": "Secondary text associated with the sub-panel shown when an 'additionalLink' is clicked.", - "type": "string" - }, - "dependsOn": { - "description": "Specifies a parameter name (usually associated with a boolean or enumerated value) whose control value this item depends on.", - "type": "string" - }, - "insertPanels": { - "description": "Indicates whether panels, contained with a panelSelector, should be inserted between the radio buttons of a radio button set indicated by the dependsOn parameter.", - "type": "boolean" - }, - "nestedPanel": { - "description": "Indicate whether panel should be nested. Nested panels are indented by 16px from the left and display left border. Default is false.", - "type": "boolean" - }, - "action": { - "description": "Action definition for 'action' items.", - "type": "object", - "$ref": "#/definitions/action_definition" - }, - "className": { - "description": "Optional class name to set for this uiItem", - "type": "string" - } - }, - "required": [ - "id", - "itemType" - ] - }, - "editor_tab_definition": { - "description": "Defines a tab or sub-tab.", - "type": "object", - "properties": { - "text": { - "description": "The text in the tab", - "type": "string" - }, - "group": { - "description": "The parameter group being displayed in the tab", - "type": "string" - }, - "content": { - "description": "The UI item to be shown.", - "type": "object", - "$ref": "#/definitions/ui_item_definition" - } - }, - "required": [ - "text", - "group", - "uiItem" - ] - }, - "text_panel_definition": { - "description": "Defines a text panel.", - "type": "object", - "properties": { - "id": { - "description": "The panel ID", - "type": "string" - }, - "label": { - "description": "Defines a panel label.", - "type": "string" - }, - "description": { - "description": "Defines a panel description.", - "type": "string" - } - }, - "required": [ - "id" - ] - }, - "control_panel_definition": { - "description": "Defines a control panel.", - "type": "object", - "properties": { - "id": { - "description": "The panel ID", - "type": "string" - }, - "panelType": { - "description": "The type of panel.", - "type": "string", - "enum": [ - "general", - "columnSelection", - "columnSelectionRecursive", - "custom", - "summary", - "actionPanel", - "twisty" - ] - }, - "uiItems": { - "description": "List of UI items in this panel.", - "type": "array", - "items": { - "$ref": "#/definitions/ui_item_definition" - } - }, - "parameters": { - "description": "List of parameters for the custom panel", - "type": "array", - "items": { - "type": "string" - } - }, - "data": { - "description": "Data passed to customPanel when panelType=custom", - "type": "object", - "additionalProperties": true - }, - "label": { - "description": "Defines a panel label.", - "type": "string" - } - }, - "required": [ - "id", - "panelType", - "uiItems" - ] - }, - "control_definition": { - "description": "Defines a control that is used to edit a parameter.", - "type": "object", - "properties": { - "name": { - "description": "The name of the parameter that can be edited by this control.", - "type": "string" - }, - "label": { - "description": "The control label and any associated shortcuts. This may also be used for accessibility reasons so must be provided even if the control doesn't show the label.", - "type": "object", - "$ref": "#/definitions/control_label_definition" - }, - "labelVisible": { - "description": "Whether the label should be shown. Typically checkboxes don't have a separate label although this can be over-ridden.", - "type": "boolean", - "default": true - }, - "description": { - "description": "Optional description for the control", - "type": "object", - "properties": { - "text": { - "description": "The text to display", - "type": "string" - }, - "placement": { - "description": "Optional placement context", - "enum": [ - "as_tooltip", - "on_panel" - ], - "default": "as_tooltip" - } - }, - "required": [ - "text" - ] - }, - "controlType": { - "description": "The type of control.", - "type": "string", - "enum": [ - "readonly", - "readonlyTable", - "textfield", - "passwordfield", - "textarea", - "list", - "expression", - "numberfield", - "spinner", - "checkbox", - "radioset", - "checkboxset", - "toggletext", - "toggle", - "oneofselect", - "multiselect", - "someofselect", - "selectcolumn", - "selectcolumns", - "structuretable", - "structureeditor", - "structurelisteditor", - "structureeditor", - "custom", - "datefield", - "datepicker", - "datepickerRange", - "timefield", - "timestampfield" - ] - }, - "valueDef": { - "description": "The basic metadata about the parameter associated with the control.", - "type": "object", - "$ref": "#/definitions/value_definition" - }, - "role": { - "description": "The additional information about the role as defined by the parameter declaration.", - "type": "string" - }, - "increment": { - "description": "Determines the increment/decrement value for the spinner control only", - "type": "number", - "default": 1 - }, - "charLimit": { - "description": "Control text size limit.", - "type": "integer" - }, - "additionalText": { - "description": "The additional text to be shown close to the control.", - "type": "string" - }, - "orientation": { - "description": "Defines the flow of any sub-controls e.g. radio buttons or checkboxes.", - "type": "string", - "enum": [ - "vertical", - "horizontal" - ] - }, - "values": { - "description": "For enumerated types, this defines the set of valid values.", - "type": "array", - "items": { - "type": "string" - } - }, - "valueLabels": { - "description": "For enumerated types, this defines the set of labels for the valid values. The ordering must be consistent with the order in the 'values' attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "valueIcons": { - "description": "For enumerated types, this defines the set of icons for the valid values. The ordering must be consistent with the order in the 'values' attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "moveableRows": { - "description": "For structure types, determines if rows can be moved up or down in a table", - "type": "boolean" - }, - "row_selection": { - "description": "Determines how many rows can be selected at a time. 'multiple-edit': select multiple rows and allow the editing of column values for all selected rows.", - "type": "string", - "enum": [ - "single", - "multiple", - "multiple-edit" - ] - }, - "subControls": { - "description": "For structure types, this defines the control information for sub-parameters. Used to render the table columns and the sub-panel.", - "type": "array", - "items": { - "$ref": "#/definitions/control_definition" - } - }, - "keyIndex": { - "description": "For structure/tabular controls, indicates which column index is the key (-1 indicates no key).", - "type": "integer" - }, - "defaultRow": { - "description": "For structure/tabular controls, specifies the initial values for the new row/structure (e.g. when a '+' button is pressed).", - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/definitions/parameterRef_definition" - }, - { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "array" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - } - }, - "noPickColumns": { - "description": "Suppresses Add/Remove Columns from structure tables residing within columnSelection or columnAllocation panels", - "type": "boolean" - }, - "childItem": { - "description": "The basic metadata about the parameter associated with the control.", - "type": "object", - "$ref": "#/definitions/ui_item_definition" - }, - "editStyle": { - "description": "Editing style of elements in a table", - "type": "string", - "enum": [ - "subpanel", - "inline", - "on_panel" - ] - }, - "summary": { - "description": "Determines if this column values will be shown in the summaryPanel", - "type": "boolean" - }, - "required": { - "description": "True when this parameter must be provided in order to execute.", - "type": "boolean" - }, - "customControlId": { - "description": "Used to determine which custom control to use when controlType=custom.", - "type": "string" - }, - "data": { - "description": "Data passed to custom control when controlType=custom", - "type": "object", - "additionalProperties": true - }, - "dateFormat": { - "description": "A format string such as YYYY-MM-DD which describes the display and entry format for a date field.", - "type": "string" - }, - "timeFormat": { - "description": "A format string such as HH:mm:ss which describes the display and entry format for a time field.", - "type": "string" - }, - "rows": { - "description": "Number of rows to display in tables", - "type": "integer", - "default": 4 - }, - "header": { - "description": "Determines if the table header should be displayed", - "type": "boolean", - "default": true - }, - "dmDefault": { - "description": "Used within complex structures containing 'column' key_definition fields. This associates the subControl parameter with a field attribute in the current record schema.", - "type": "boolean", - "default": false - }, - "dmImage": { - "description": "This can be set to display an icon of the corresponding dm type in the `role`:`column' field of a table.", - "type": "string" - }, - "includeAllFields": { - "description": "Set to true to include all fields in the control at all times", - "type": "boolean", - "default": false - }, - "layout": { - "description": "Array of rows containing structure element names", - "type": "array", - "items": { - "description": "A single row of structure parameter names for laying out horizontally", - "type": "array", - "items": { - "description": "A parameter name within the current structure", - "type": "string" - } - } - }, - "visible": { - "description": "Whether the table showing the structures includes a column for this sub-parameter for subControls", - "type": "boolean" - }, - "width": { - "description": "Suggested width of the column in the table that shows the current value for subControls.", - "type": "integer" - }, - "displayChars": { - "description": "Limits the number of characters displayed for a text field in a column in a table. The text will have an ellipsis appended at this limit.", - "type": "integer", - "default": 64 - }, - "sortable": { - "description": "Determines if this column values can be sorted into ascending/descending order in a table", - "type": "boolean" - }, - "filterable": { - "description": "Determines if this column values can be filtered so that only rows that match the filter in column values are shown in the table", - "type": "boolean" - }, - "language": { - "description": "The language for the expression editor syntax highlight and autocomplete workds. Applies to expression control type.", - "type": "string", - "enum": [ - "CLEM", - "text/x-hive", - "text/x-rsrc", - "text/x-python", - "text/x-sql" - ] - }, - "customValueAllowed": { - "description": "Determines if a dropdown, outside of a table, can allow a custom value to be entered", - "type": "boolean" - }, - "className": { - "description": "Optional class name to set for this control", - "type": "string" - }, - "light": { - "description": "The background color of controls such as text input. Can be set at the Common Properties level for all or at the control", - "type": "boolean", - "default": true - } - }, - "required": [ - "name", - "label", - "separateLabel", - "controlType", - "valueDef" - ] - }, - "control_label_definition": { - "description": "Defines a control label.", - "type": "object", - "properties": { - "text": { - "description": "The label text.", - "type": "string" - }, - "number_generator": { - "description": "Adds a number generation button beside the numeric control", - "type": "object", - "properties": { - "label": { - "description": "Number generator button label. It is visible on hover.", - "type": "string" - }, - "range": { - "description": "Number generator range", - "type": "object", - "properties": { - "min": { - "description": "Maximum value for generated numbers", - "type": "number" - } - }, - "required": [ - "min", - "max" - ] - } - }, - "required": [ - "label" - ] - } - }, - "required": [ - "text" - ] - }, - "value_definition": { - "description": "Defines basic value metadata.", - "type": "object", - "properties": { - "propType": { - "description": "The basic property type.", - "type": "string", - "enum": [ - "boolean", - "integer", - "long", - "double", - "string", - "password", - "date", - "structure" - ] - }, - "isList": { - "description": "Whether the value is represented as a list.", - "type": "boolean" - }, - "isMap": { - "description": "Whether the value is represented as a map.", - "type": "boolean" - }, - "defaultValue": { - "description": "Optional default value", - "anyOf": [ - { - "$ref": "#/definitions/parameterRef_definition" - }, - { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "array" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - } - }, - "required": [ - "propType", - "isList", - "isMap" - ] - }, - "parameterRef_definition": { - "description": "Structure for parameter refs", - "type": "object", - "properties": { - "parameterRef": { - "description": "Reference to another parameter.", - "type": "string" - } - }, - "required": [ - "parameterRef" - ] - }, - "action_definition": { - "description": "Defines a action that is used to callback to the application.", - "type": "object", - "properties": { - "name": { - "description": "The name of the action.", - "type": "string" - }, - "label": { - "description": "The action label. Usually the label on a button.", - "type": "object", - "$ref": "#/definitions/control_label_definition" - }, - "description": { - "description": "Defines a action description. Used for tooltip.", - "type": "object", - "properties": { - "text": { - "description": "The description text.", - "type": "string" - } - } - }, - "actionType": { - "description": "The type of action.", - "type": "string", - "enum": [ - "button", - "image" - ] - }, - "image": { - "description": "Properties for how the image will look. Use when control=image.", - "type": "object", - "properties": { - "url": { - "description": "image url to be used for action", - "type": "string" - }, - "placement": { - "description": "placement of the action image", - "enum": [ - "right", - "left" - ] - }, - "size": { - "description": "pixel size of the image.", - "type": "object", - "properties": { - "height": { - "description": "image height in pixels", - "type": "number" - }, - "width": { - "description": "image width in pixels", - "type": "number" - } - } - } - } - }, - "data": { - "description": "Data returned when action called", - "type": "object", - "additionalProperties": true - } - }, - "required": [ - "name", - "label", - "actionType" - ] - }, - "button_definition": { - "description": "Defines a button and any associated callback.", - "type": "object", - "properties": { - "id": { - "description": "Button identifier", - "type": "string" - }, - "text": { - "description": "Button label text", - "type": "string" - }, - "isPrimary": { - "description": "Whether the button is the primary/default button.", - "type": "boolean" - }, - "url": { - "description": "The endpoint to be called when the button is pressed.", - "type": "string" - } - }, - "required": [ - "id", - "text", - "isPrimary", - "url" - ] - }, - "form_data_definition": { - "description": "Additional data such as initial settings and input data schema.", - "type": "object", - "properties": { - "currentParameters": { - "description": "Current parameter set upon input. Keys are parameter names, values are their values.", - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "datasetMetadata": { - "oneOf": [ - { - "description": "A single datarecord object. Deprecated.", - "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v3-schema.json#" - }, - { - "description": "An array of datarecord objects", - "type": "array", - "items": { - "$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v3-schema.json#" - } - } - ] - } - }, - "required": [ - "currentParameters" - ] - } - } -} diff --git a/common-pipeline/operators/uihints-v3-schema.json b/common-pipeline/operators/uihints-v3-schema.json index 0ccc9d4..b5ddbe1 100644 --- a/common-pipeline/operators/uihints-v3-schema.json +++ b/common-pipeline/operators/uihints-v3-schema.json @@ -29,6 +29,18 @@ "description": "URL to operation icon", "type": "string" }, + "title_info": { + "type": "object", + "properties": { + "action_refs": { + "description": "List of actions to be displayed in the title section", + "type": "array", + "items": { + "type": "string" + } + } + } + }, "group_info": { "type": "array", "items": {