@mat3ra/esse 2024.3.25-2 → 2024.3.25-3

package/dist/js/schema/workflow/unit/io.json

@@ -0,0 +1,415 @@
+{
+    "$id": "workflow/unit/io",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "data IO unit schema",
+    "type": "object",
+    "required": [
+        "flowchartId",
+        "input",
+        "source",
+        "subtype",
+        "type"
+    ],
+    "additionalProperties": true,
+    "properties": {
+        "type": {
+            "enum": [
+                "io"
+            ],
+            "description": "type of the unit",
+            "type": "string"
+        },
+        "subtype": {
+            "enum": [
+                "input",
+                "output",
+                "dataFrame"
+            ]
+        },
+        "source": {
+            "enum": [
+                "api",
+                "db",
+                "object_storage"
+            ]
+        },
+        "input": {
+            "type": "array",
+            "items": {
+                "anyOf": [
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "data IO rest API input schema",
+                        "type": "object",
+                        "properties": {
+                            "endpoint": {
+                                "description": "rest API endpoint",
+                                "type": "string"
+                            },
+                            "endpoint_options": {
+                                "description": "rest API endpoint options",
+                                "type": "object"
+                            },
+                            "name": {
+                                "description": "the name of the variable in local scope to save the data under",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "endpoint",
+                            "endpoint_options"
+                        ],
+                        "additionalProperties": true
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "data IO database input/output schema",
+                        "type": "object",
+                        "oneOf": [
+                            {
+                                "properties": {
+                                    "ids": {
+                                        "description": "IDs of item to retrieve from db",
+                                        "type": "array",
+                                        "items": {
+                                            "type": "string"
+                                        }
+                                    }
+                                },
+                                "required": [
+                                    "ids"
+                                ],
+                                "additionalProperties": true
+                            },
+                            {
+                                "properties": {
+                                    "collection": {
+                                        "description": "db collection name",
+                                        "type": "string"
+                                    },
+                                    "draft": {
+                                        "description": "whether the result should be saved as draft",
+                                        "type": "boolean",
+                                        "default": true
+                                    }
+                                },
+                                "required": [
+                                    "collection",
+                                    "draft"
+                                ],
+                                "additionalProperties": true
+                            }
+                        ]
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "object_storage io schema",
+                        "type": "object",
+                        "required": [
+                            "objectData"
+                        ],
+                        "additionalProperties": true,
+                        "properties": {
+                            "objectData": {
+                                "$schema": "http://json-schema.org/draft-07/schema#",
+                                "title": "Object Storage Container Data",
+                                "type": "object",
+                                "properties": {
+                                    "CONTAINER": {
+                                        "description": "Object storage container for the file",
+                                        "type": "string"
+                                    },
+                                    "NAME": {
+                                        "description": "Name of the file inside the object storage bucket",
+                                        "type": "string"
+                                    },
+                                    "PROVIDER": {
+                                        "description": "Object storage provider",
+                                        "type": "string"
+                                    },
+                                    "REGION": {
+                                        "description": "Region for the object container specified in Container",
+                                        "type": "string"
+                                    },
+                                    "SIZE": {
+                                        "description": "Size of the file in bytes",
+                                        "type": "integer"
+                                    },
+                                    "TIMESTAMP": {
+                                        "description": "Unix timestamp showing when the file was last modified",
+                                        "type": "string"
+                                    }
+                                }
+                            },
+                            "overwrite": {
+                                "description": "if a file with the same filename already exists, whether to overwrite the old file",
+                                "type": "boolean",
+                                "default": false
+                            },
+                            "pathname": {
+                                "description": "Relative path to the directory that contains the file.",
+                                "type": "string"
+                            },
+                            "basename": {
+                                "description": "Basename of the file",
+                                "type": "string",
+                                "$comment": "isGenerative:true"
+                            },
+                            "filetype": {
+                                "description": "What kind of file this is, e.g. image / text",
+                                "type": "string"
+                            }
+                        }
+                    }
+                ]
+            }
+        },
+        "_id": {
+            "type": "string",
+            "description": "entity identity"
+        },
+        "isDraft": {
+            "type": "boolean"
+        },
+        "name": {
+            "description": "name of the unit. e.g. pw_scf",
+            "type": "string"
+        },
+        "status": {
+            "description": "Status of the unit.",
+            "type": "string",
+            "enum": [
+                "idle",
+                "active",
+                "warning",
+                "error",
+                "finished"
+            ]
+        },
+        "head": {
+            "description": "Whether this unit is the first one to be executed.",
+            "type": "boolean"
+        },
+        "flowchartId": {
+            "description": "Identity of the unit in the workflow. Used to trace the execution flow of the workflow.",
+            "type": "string"
+        },
+        "next": {
+            "description": "Next unit's flowchartId. If empty, the current unit is the last.",
+            "type": "string"
+        },
+        "enableRender": {
+            "description": "Whether Rupy should attempt to use Jinja templating to add context variables into the unit",
+            "type": "boolean"
+        },
+        "context": {
+            "type": "object"
+        },
+        "slug": {
+            "description": "entity slug",
+            "type": "string"
+        },
+        "systemName": {
+            "type": "string"
+        },
+        "consistencyChecks": {
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "consistency check",
+                "type": "object",
+                "description": "The output of consistency checks performed on data adhering to JSON schema, but inconsistent with scientific or logical rules, to show problems in UI.",
+                "required": [
+                    "key",
+                    "name",
+                    "severity",
+                    "message"
+                ],
+                "properties": {
+                    "key": {
+                        "type": "string",
+                        "description": "Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'"
+                    },
+                    "name": {
+                        "enum": [
+                            "default",
+                            "atomsTooClose",
+                            "atomsOverlap"
+                        ],
+                        "description": "Name of the consistency check that is performed, which is listed in an enum."
+                    },
+                    "severity": {
+                        "enum": [
+                            "info",
+                            "warning",
+                            "error"
+                        ],
+                        "description": "Severity level of the problem, which is used in UI to differentiate."
+                    },
+                    "message": {
+                        "type": "string",
+                        "description": "Message generated by the consistency check describing the problem."
+                    }
+                }
+            }
+        },
+        "schemaVersion": {
+            "description": "entity's schema version. Used to distinct between different schemas.",
+            "type": "string",
+            "default": "2022.8.16"
+        },
+        "isDefault": {
+            "description": "Identifies that entity is defaultable",
+            "type": "boolean",
+            "default": false
+        },
+        "preProcessors": {
+            "description": "names of the pre-processors for this calculation",
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "runtime item schema",
+                "oneOf": [
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "name result schema",
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "description": "The name of this item. e.g. scf_accuracy",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "name"
+                        ]
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "RuntimeItemString",
+                        "description": "name of runtime item in shortened notation",
+                        "type": "string"
+                    }
+                ]
+            }
+        },
+        "postProcessors": {
+            "description": "names of the post-processors for this calculation",
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "runtime item schema",
+                "oneOf": [
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "name result schema",
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "description": "The name of this item. e.g. scf_accuracy",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "name"
+                        ]
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "RuntimeItemString",
+                        "description": "name of runtime item in shortened notation",
+                        "type": "string"
+                    }
+                ]
+            }
+        },
+        "monitors": {
+            "description": "names of the monitors for this calculation",
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "runtime item schema",
+                "oneOf": [
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "name result schema",
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "description": "The name of this item. e.g. scf_accuracy",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "name"
+                        ]
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "RuntimeItemString",
+                        "description": "name of runtime item in shortened notation",
+                        "type": "string"
+                    }
+                ]
+            }
+        },
+        "results": {
+            "description": "names of the results for this calculation",
+            "type": "array",
+            "items": {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "runtime item schema",
+                "oneOf": [
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "name result schema",
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "description": "The name of this item. e.g. scf_accuracy",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "name"
+                        ]
+                    },
+                    {
+                        "$schema": "http://json-schema.org/draft-07/schema#",
+                        "title": "RuntimeItemString",
+                        "description": "name of runtime item in shortened notation",
+                        "type": "string"
+                    }
+                ]
+            }
+        },
+        "tags": {
+            "description": "entity tags",
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "statusTrack": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": [
+                    "trackedAt",
+                    "status"
+                ],
+                "properties": {
+                    "trackedAt": {
+                        "type": "number"
+                    },
+                    "status": {
+                        "type": "string"
+                    },
+                    "repetition": {
+                        "type": "number"
+                    }
+                }
+            }
+        }
+    }
+}