kiara_model_types
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name AuthorsMetadataModel
python_module_name kiara.models.documentation
full_name kiara.models.documentation.AuthorsMetadataModel
metadata_schema {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
},
"definitions": {
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
}
}
}
metadata.context
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ContextMetadataModel
python_module_name kiara.models.documentation
full_name kiara.models.documentation.ContextMetadataModel
metadata_schema {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"definitions": {
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
}
}
}
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name DocumentationMetadataModel
python_module_name kiara.models.documentation
full_name kiara.models.documentation.DocumentationMetadataModel
metadata_schema {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
}
instance.wrapped_python_class
Documentation
Python class and module information.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name PythonClass
python_module_name kiara.models.python_class
full_name kiara.models.python_class.PythonClass
metadata_schema {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
}
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name KiaraModuleClass
python_module_name kiara.models.module
full_name kiara.models.module.KiaraModuleClass
metadata_schema {
"title": "KiaraModuleClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"inputs_schema": {
"title": "Inputs Schema",
"description": "The schema for the module input(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"outputs_schema": {
"title": "Outputs Schema",
"description": "The schema for the module output(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name",
"module_config",
"inputs_schema",
"outputs_schema"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
}
}
}
info.kiara_model
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name KiaraModelTypeInfo
python_module_name kiara.models.info
full_name kiara.models.info.KiaraModelTypeInfo
metadata_schema {
"title": "KiaraModelTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"metadata_schema": {
"title": "Metadata Schema",
"description": "The (json) schema for this model data.",
"type": "object"
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"metadata_schema"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
}
}
}
info.kiara_module_type
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name KiaraModuleTypeInfo
python_module_name kiara.models.module
full_name kiara.models.module.KiaraModuleTypeInfo
metadata_schema {
"title": "KiaraModuleTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"process_src": {
"title": "Process Src",
"description": "The source code of the process method of the module.",
"type": "string"
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"process_src"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
}
}
}
info.archive_type
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ArchiveTypeInfo
python_module_name kiara.models.archives
full_name kiara.models.archives.ArchiveTypeInfo
metadata_schema {
"title": "ArchiveTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"is_writable": {
"title": "Is Writable",
"description": "Whether this archive is writeable.",
"default": false,
"type": "boolean"
},
"supported_item_types": {
"title": "Supported Item Types",
"description": "The item types this archive suports.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"supported_item_types"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
}
}
}
info.operation_type
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name OperationTypeInfo
python_module_name kiara.models.module.operation
full_name kiara.models.module.operation.OperationTypeInfo
metadata_schema {
"title": "OperationTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
}
}
}
info.data_type
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name DataTypeClassInfo
python_module_name kiara.models.values.data_type
full_name kiara.models.values.data_type.DataTypeClassInfo
metadata_schema {
"title": "DataTypeClassInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"value_cls": {
"title": "Value Cls",
"description": "The python class of the value itself.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"data_type_config_cls": {
"title": "Data Type Config Cls",
"description": "The python class holding the schema for configuring this type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"lineage": {
"title": "Lineage",
"description": "This types lineage.",
"type": "array",
"items": {
"type": "string"
}
},
"qualifier_profiles": {
"title": "Qualifier Profiles",
"description": "A map of qualifier profiles for this data types.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"value_cls",
"data_type_config_cls"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
}
}
}
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name MetadataTypeInfo
python_module_name kiara.models.values.value_metadata
full_name kiara.models.values.value_metadata.MetadataTypeInfo
metadata_schema {
"title": "MetadataTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"metadata_schema": {
"title": "Metadata Schema",
"description": "The (json) schema for this metadata value.",
"type": "object"
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"metadata_schema"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
}
}
}
archive_info
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ArchiveInfo
python_module_name kiara.models.archives
full_name kiara.models.archives.ArchiveInfo
metadata_schema {
"title": "ArchiveInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"archive_id": {
"title": "Archive Id",
"description": "The (globally unique) archive id.",
"type": "string",
"format": "uuid"
},
"archive_type_info": {
"title": "Archive Type Info",
"description": "Information about this archives' type.",
"allOf": [
{
"$ref": "#/definitions/ArchiveTypeInfo"
}
]
},
"config": {
"title": "Config",
"description": "The configuration of this archive.",
"type": "object"
},
"details": {
"title": "Details",
"description": "Type dependent (runtime) details for this archive.",
"allOf": [
{
"$ref": "#/definitions/ArchiveDetails"
}
]
},
"aliases": {
"title": "Aliases",
"description": "Aliases for this archive.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"archive_id",
"archive_type_info",
"config",
"details"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"ArchiveTypeInfo": {
"title": "ArchiveTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"is_writable": {
"title": "Is Writable",
"description": "Whether this archive is writeable.",
"default": false,
"type": "boolean"
},
"supported_item_types": {
"title": "Supported Item Types",
"description": "The item types this archive suports.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"supported_item_types"
],
"additionalProperties": false
},
"ArchiveDetails": {
"title": "ArchiveDetails",
"type": "object",
"properties": {
"size": {
"title": "Size",
"description": "The size of the stored archive.",
"type": "integer"
}
}
}
}
}
info.operation
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name OperationInfo
python_module_name kiara.models.module.operation
full_name kiara.models.module.operation.OperationInfo
metadata_schema {
"title": "OperationInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"operation": {
"title": "Operation",
"description": "The operation instance.",
"allOf": [
{
"$ref": "#/definitions/Operation"
}
]
},
"operation_types": {
"title": "Operation Types",
"description": "The operation types this operation belongs to.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"operation",
"operation_types"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"OperationDetails": {
"title": "OperationDetails",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"operation_id": {
"title": "Operation Id",
"description": "The id of the operation.",
"type": "string"
},
"is_internal_operation": {
"title": "Is Internal Operation",
"description": "Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation list…
"default": false,
"type": "boolean"
}
},
"required": [
"operation_id"
],
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"KiaraModuleClass": {
"title": "KiaraModuleClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"inputs_schema": {
"title": "Inputs Schema",
"description": "The schema for the module input(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"outputs_schema": {
"title": "Outputs Schema",
"description": "The schema for the module output(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name",
"module_config",
"inputs_schema",
"outputs_schema"
],
"additionalProperties": false
},
"Operation": {
"title": "Operation",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"operation_id": {
"title": "Operation Id",
"description": "The (unique) id of this operation.",
"type": "string"
},
"operation_details": {
"title": "Operation Details",
"description": "The operation specific details of this operation.",
"allOf": [
{
"$ref": "#/definitions/OperationDetails"
}
]
},
"doc": {
"title": "Doc",
"description": "Documentation for this operation.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"module_details": {
"title": "Module Details",
"description": "The class of the underlying module.",
"allOf": [
{
"$ref": "#/definitions/KiaraModuleClass"
}
]
},
"metadata": {
"title": "Metadata",
"description": "Additional metadata for this operation.",
"type": "object"
}
},
"required": [
"module_type",
"operation_id",
"operation_details",
"doc",
"module_details"
],
"additionalProperties": false
}
}
}
info.pipeline
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name PipelineInfo
python_module_name kiara.models.module.pipeline.pipeline
full_name kiara.models.module.pipeline.pipeline.PipelineInfo
metadata_schema {
"title": "PipelineInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"pipeline_structure": {
"title": "Pipeline Structure",
"description": "The pipeline structure.",
"allOf": [
{
"$ref": "#/definitions/PipelineStructure"
}
]
},
"pipeline_details": {
"title": "Pipeline Details",
"description": "The current input details.",
"allOf": [
{
"$ref": "#/definitions/PipelineDetails"
}
]
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"pipeline_structure",
"pipeline_details"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"StepValueAddress": {
"title": "StepValueAddress",
"description": "Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure.",
"type": "object",
"properties": {
"step_id": {
"title": "Step Id",
"description": "The id of a step within a pipeline.",
"type": "string"
},
"value_name": {
"title": "Value Name",
"description": "The name of the value (output name or pipeline input name).",
"type": "string"
},
"sub_value": {
"title": "Sub Value",
"description": "A reference to a subitem of a value (e.g. column, list item)",
"type": "object"
}
},
"required": [
"step_id",
"value_name"
],
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"KiaraModuleClass": {
"title": "KiaraModuleClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"inputs_schema": {
"title": "Inputs Schema",
"description": "The schema for the module input(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"outputs_schema": {
"title": "Outputs Schema",
"description": "The schema for the module output(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name",
"module_config",
"inputs_schema",
"outputs_schema"
],
"additionalProperties": false
},
"PipelineStep": {
"title": "PipelineStep",
"description": "A step within a pipeline-structure, includes information about it's connection(s) and other metadat…
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"step_id": {
"title": "Step Id",
"description": "Locally unique id (within a pipeline) of this step.",
"type": "string"
},
"input_links": {
"title": "Input Links",
"description": "The links that connect to inputs of the module. Keys are field names, value(s) are connected ou…
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/StepValueAddress"
}
}
},
"module_details": {
"title": "Module Details",
"description": "The class of the underlying module.",
"allOf": [
{
"$ref": "#/definitions/KiaraModuleClass"
}
]
},
"doc": {
"title": "Doc",
"description": "A description what this step does.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"module_type",
"step_id",
"module_details",
"doc"
],
"additionalProperties": false
},
"PipelineConfig": {
"title": "PipelineConfig",
"description": "A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule].\n\n…
"type": "object",
"properties": {
"constants": {
"title": "Constants",
"description": "Value constants for this module.",
"type": "object"
},
"defaults": {
"title": "Defaults",
"description": "Value defaults for this module.",
"type": "object"
},
"pipeline_name": {
"title": "Pipeline Name",
"description": "The name of this pipeline.",
"type": "string"
},
"steps": {
"title": "Steps",
"description": "A list of steps/modules of this pipeline, and their connections.",
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"input_aliases": {
"title": "Input Aliases",
"description": "A map of input aliases, with the calculated (<step_id>__<input_name> -- double underscore!) nam…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"output_aliases": {
"title": "Output Aliases",
"description": "A map of output aliases, with the calculated (<step_id>__<output_name> -- double underscore!) n…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"doc": {
"title": "Doc",
"description": "Documentation about what the pipeline does.",
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Metadata for this workflow.",
"type": "object"
}
},
"required": [
"pipeline_name",
"steps",
"input_aliases",
"output_aliases"
]
},
"PipelineStructure": {
"title": "PipelineStructure",
"description": "An object that holds one or several steps, and describes the connections between them.",
"type": "object",
"properties": {
"pipeline_config": {
"title": "Pipeline Config",
"description": "The underlying pipeline config.",
"allOf": [
{
"$ref": "#/definitions/PipelineConfig"
}
]
},
"steps": {
"title": "Steps",
"description": "The pipeline steps ",
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"input_aliases": {
"title": "Input Aliases",
"description": "The input aliases.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"output_aliases": {
"title": "Output Aliases",
"description": "The output aliases.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"pipeline_config",
"steps",
"input_aliases",
"output_aliases"
],
"additionalProperties": false
},
"StepStatus": {
"title": "StepStatus",
"description": "Enum to describe the state of a workflow.",
"enum": [
"inputs_invalid",
"inputs_ready",
"results_ready"
]
},
"StepDetails": {
"title": "StepDetails",
"type": "object",
"properties": {
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context.",
"type": "string",
"format": "uuid"
},
"pipeline_id": {
"title": "Pipeline Id",
"description": "The id of the pipeline.",
"type": "string",
"format": "uuid"
},
"step": {
"title": "Step",
"description": "The pipeline step details.",
"allOf": [
{
"$ref": "#/definitions/PipelineStep"
}
]
},
"step_id": {
"title": "Step Id",
"description": "The id of the step.",
"type": "string"
},
"processing_stage": {
"title": "Processing Stage",
"description": "The execution stage where this step is executed.",
"type": "integer"
},
"status": {
"description": "The current status of this step.",
"allOf": [
{
"$ref": "#/definitions/StepStatus"
}
]
},
"invalid_details": {
"title": "Invalid Details",
"description": "Details about fields that are invalid (if status < 'INPUTS_READY'.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"inputs": {
"title": "Inputs",
"description": "The current inputs of this step.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"outputs": {
"title": "Outputs",
"description": "The current outputs of this step.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
}
},
"required": [
"kiara_id",
"pipeline_id",
"step",
"step_id",
"processing_stage",
"status",
"inputs",
"outputs"
]
},
"PipelineDetails": {
"title": "PipelineDetails",
"type": "object",
"properties": {
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context.",
"type": "string",
"format": "uuid"
},
"pipeline_id": {
"title": "Pipeline Id",
"description": "The id of the pipeline.",
"type": "string",
"format": "uuid"
},
"pipeline_status": {
"description": "The current status of this pipeline.",
"allOf": [
{
"$ref": "#/definitions/StepStatus"
}
]
},
"invalid_details": {
"title": "Invalid Details",
"description": "Details about fields that are invalid (if status < 'INPUTS_READY'.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"pipeline_inputs": {
"title": "Pipeline Inputs",
"description": "The current pipeline inputs.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"pipeline_outputs": {
"title": "Pipeline Outputs",
"description": "The current pipeline outputs.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"step_states": {
"title": "Step States",
"description": "The state of each step within this pipeline.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/StepDetails"
}
}
},
"required": [
"kiara_id",
"pipeline_id",
"pipeline_status",
"pipeline_inputs",
"pipeline_outputs",
"step_states"
]
}
}
}
info.workflow
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name WorkflowInfo
python_module_name kiara.models.workflow
full_name kiara.models.workflow.WorkflowInfo
metadata_schema {
"title": "WorkflowInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"workflow_details": {
"title": "Workflow Details",
"description": "The workflow details.",
"allOf": [
{
"$ref": "#/definitions/WorkflowDetails"
}
]
},
"workflow_states": {
"title": "Workflow States",
"description": "All states for this workflow.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/WorkflowState"
}
},
"pipeline_info": {
"title": "Pipeline Info",
"description": "The current state of the workflows' pipeline.",
"allOf": [
{
"$ref": "#/definitions/PipelineInfo"
}
]
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"workflow_details",
"workflow_states",
"pipeline_info"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"WorkflowDetails": {
"title": "WorkflowDetails",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"workflow_id": {
"title": "Workflow Id",
"description": "The globally unique uuid for this workflow.",
"type": "string",
"format": "uuid"
},
"documentation": {
"title": "Documentation",
"description": "A description for this workflow.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "The author(s) of this workflow.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Workflow context details.",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"current_state": {
"title": "Current State",
"description": "A reference to the current state of this workflow.",
"type": "string"
},
"workflow_states": {
"title": "Workflow States",
"description": "A history of all the states of this workflow.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"additionalProperties": false
},
"StepValueAddress": {
"title": "StepValueAddress",
"description": "Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure.",
"type": "object",
"properties": {
"step_id": {
"title": "Step Id",
"description": "The id of a step within a pipeline.",
"type": "string"
},
"value_name": {
"title": "Value Name",
"description": "The name of the value (output name or pipeline input name).",
"type": "string"
},
"sub_value": {
"title": "Sub Value",
"description": "A reference to a subitem of a value (e.g. column, list item)",
"type": "object"
}
},
"required": [
"step_id",
"value_name"
],
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"KiaraModuleClass": {
"title": "KiaraModuleClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"inputs_schema": {
"title": "Inputs Schema",
"description": "The schema for the module input(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"outputs_schema": {
"title": "Outputs Schema",
"description": "The schema for the module output(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name",
"module_config",
"inputs_schema",
"outputs_schema"
],
"additionalProperties": false
},
"PipelineStep": {
"title": "PipelineStep",
"description": "A step within a pipeline-structure, includes information about it's connection(s) and other metadat…
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"step_id": {
"title": "Step Id",
"description": "Locally unique id (within a pipeline) of this step.",
"type": "string"
},
"input_links": {
"title": "Input Links",
"description": "The links that connect to inputs of the module. Keys are field names, value(s) are connected ou…
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/StepValueAddress"
}
}
},
"module_details": {
"title": "Module Details",
"description": "The class of the underlying module.",
"allOf": [
{
"$ref": "#/definitions/KiaraModuleClass"
}
]
},
"doc": {
"title": "Doc",
"description": "A description what this step does.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"module_type",
"step_id",
"module_details",
"doc"
],
"additionalProperties": false
},
"PipelineConfig": {
"title": "PipelineConfig",
"description": "A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule].\n\n…
"type": "object",
"properties": {
"constants": {
"title": "Constants",
"description": "Value constants for this module.",
"type": "object"
},
"defaults": {
"title": "Defaults",
"description": "Value defaults for this module.",
"type": "object"
},
"pipeline_name": {
"title": "Pipeline Name",
"description": "The name of this pipeline.",
"type": "string"
},
"steps": {
"title": "Steps",
"description": "A list of steps/modules of this pipeline, and their connections.",
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"input_aliases": {
"title": "Input Aliases",
"description": "A map of input aliases, with the calculated (<step_id>__<input_name> -- double underscore!) nam…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"output_aliases": {
"title": "Output Aliases",
"description": "A map of output aliases, with the calculated (<step_id>__<output_name> -- double underscore!) n…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"doc": {
"title": "Doc",
"description": "Documentation about what the pipeline does.",
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Metadata for this workflow.",
"type": "object"
}
},
"required": [
"pipeline_name",
"steps",
"input_aliases",
"output_aliases"
]
},
"PipelineStructure": {
"title": "PipelineStructure",
"description": "An object that holds one or several steps, and describes the connections between them.",
"type": "object",
"properties": {
"pipeline_config": {
"title": "Pipeline Config",
"description": "The underlying pipeline config.",
"allOf": [
{
"$ref": "#/definitions/PipelineConfig"
}
]
},
"steps": {
"title": "Steps",
"description": "The pipeline steps ",
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"input_aliases": {
"title": "Input Aliases",
"description": "The input aliases.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"output_aliases": {
"title": "Output Aliases",
"description": "The output aliases.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"pipeline_config",
"steps",
"input_aliases",
"output_aliases"
],
"additionalProperties": false
},
"StepStatus": {
"title": "StepStatus",
"description": "Enum to describe the state of a workflow.",
"enum": [
"inputs_invalid",
"inputs_ready",
"results_ready"
]
},
"StepDetails": {
"title": "StepDetails",
"type": "object",
"properties": {
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context.",
"type": "string",
"format": "uuid"
},
"pipeline_id": {
"title": "Pipeline Id",
"description": "The id of the pipeline.",
"type": "string",
"format": "uuid"
},
"step": {
"title": "Step",
"description": "The pipeline step details.",
"allOf": [
{
"$ref": "#/definitions/PipelineStep"
}
]
},
"step_id": {
"title": "Step Id",
"description": "The id of the step.",
"type": "string"
},
"processing_stage": {
"title": "Processing Stage",
"description": "The execution stage where this step is executed.",
"type": "integer"
},
"status": {
"description": "The current status of this step.",
"allOf": [
{
"$ref": "#/definitions/StepStatus"
}
]
},
"invalid_details": {
"title": "Invalid Details",
"description": "Details about fields that are invalid (if status < 'INPUTS_READY'.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"inputs": {
"title": "Inputs",
"description": "The current inputs of this step.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"outputs": {
"title": "Outputs",
"description": "The current outputs of this step.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
}
},
"required": [
"kiara_id",
"pipeline_id",
"step",
"step_id",
"processing_stage",
"status",
"inputs",
"outputs"
]
},
"PipelineDetails": {
"title": "PipelineDetails",
"type": "object",
"properties": {
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context.",
"type": "string",
"format": "uuid"
},
"pipeline_id": {
"title": "Pipeline Id",
"description": "The id of the pipeline.",
"type": "string",
"format": "uuid"
},
"pipeline_status": {
"description": "The current status of this pipeline.",
"allOf": [
{
"$ref": "#/definitions/StepStatus"
}
]
},
"invalid_details": {
"title": "Invalid Details",
"description": "Details about fields that are invalid (if status < 'INPUTS_READY'.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"pipeline_inputs": {
"title": "Pipeline Inputs",
"description": "The current pipeline inputs.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"pipeline_outputs": {
"title": "Pipeline Outputs",
"description": "The current pipeline outputs.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"step_states": {
"title": "Step States",
"description": "The state of each step within this pipeline.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/StepDetails"
}
}
},
"required": [
"kiara_id",
"pipeline_id",
"pipeline_status",
"pipeline_inputs",
"pipeline_outputs",
"step_states"
]
},
"PipelineInfo": {
"title": "PipelineInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"pipeline_structure": {
"title": "Pipeline Structure",
"description": "The pipeline structure.",
"allOf": [
{
"$ref": "#/definitions/PipelineStructure"
}
]
},
"pipeline_details": {
"title": "Pipeline Details",
"description": "The current input details.",
"allOf": [
{
"$ref": "#/definitions/PipelineDetails"
}
]
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"pipeline_structure",
"pipeline_details"
],
"additionalProperties": false
},
"WorkflowState": {
"title": "WorkflowState",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"steps": {
"title": "Steps",
"description": "The current steps in the workflow.",
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"inputs": {
"title": "Inputs",
"description": "The current (pipeline) input values.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"pipeline_info": {
"title": "Pipeline Info",
"description": "Details about the pipeline and its state.",
"allOf": [
{
"$ref": "#/definitions/PipelineInfo"
}
]
}
},
"required": [
"pipeline_info"
],
"additionalProperties": false
}
}
}
info.kiara_models
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name KiaraModelClassesInfo
python_module_name kiara.models.info
full_name kiara.models.info.KiaraModelClassesInfo
metadata_schema {
"title": "KiaraModelClassesInfo",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"group_alias": {
"title": "Group Alias",
"description": "The group alias.",
"type": "string"
},
"type_name": {
"title": "Type Name",
"default": "kiara_model",
"enum": [
"kiara_model"
],
"type": "string"
},
"item_infos": {
"title": "Item Infos",
"description": "The value metadata info instances for each type.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/KiaraModelTypeInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"KiaraModelTypeInfo": {
"title": "KiaraModelTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"metadata_schema": {
"title": "Metadata Schema",
"description": "The (json) schema for this model data.",
"type": "object"
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"metadata_schema"
],
"additionalProperties": false
}
}
}
info.module_types
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ModuleTypeClassesInfo
python_module_name kiara.models.module
full_name kiara.models.module.ModuleTypeClassesInfo
metadata_schema {
"title": "ModuleTypeClassesInfo",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"group_alias": {
"title": "Group Alias",
"description": "The group alias.",
"type": "string"
},
"type_name": {
"title": "Type Name",
"default": "module_type",
"enum": [
"module_type"
],
"type": "string"
},
"item_infos": {
"title": "Item Infos",
"description": "The module type info instances for each type.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/KiaraModuleTypeInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"KiaraModuleTypeInfo": {
"title": "KiaraModuleTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"process_src": {
"title": "Process Src",
"description": "The source code of the process method of the module.",
"type": "string"
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"process_src"
],
"additionalProperties": false
}
}
}
info.archive_types
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ArchiveTypeClassesInfo
python_module_name kiara.models.archives
full_name kiara.models.archives.ArchiveTypeClassesInfo
metadata_schema {
"title": "ArchiveTypeClassesInfo",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"group_alias": {
"title": "Group Alias",
"description": "The group alias.",
"type": "string"
},
"type_name": {
"title": "Type Name",
"default": "archive_type",
"enum": [
"archive_type"
],
"type": "string"
},
"item_infos": {
"title": "Item Infos",
"description": "The archive info instances for each type.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ArchiveTypeInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"ArchiveTypeInfo": {
"title": "ArchiveTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"is_writable": {
"title": "Is Writable",
"description": "Whether this archive is writeable.",
"default": false,
"type": "boolean"
},
"supported_item_types": {
"title": "Supported Item Types",
"description": "The item types this archive suports.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"supported_item_types"
],
"additionalProperties": false
}
}
}
info.operation_types
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name OperationTypeClassesInfo
python_module_name kiara.models.module.operation
full_name kiara.models.module.operation.OperationTypeClassesInfo
metadata_schema {
"title": "OperationTypeClassesInfo",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"group_alias": {
"title": "Group Alias",
"description": "The group alias.",
"type": "string"
},
"type_name": {
"title": "Type Name",
"default": "operation_type",
"enum": [
"operation_type"
],
"type": "string"
},
"item_infos": {
"title": "Item Infos",
"description": "The operation info instances for each type.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/OperationTypeInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"OperationTypeInfo": {
"title": "OperationTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class"
],
"additionalProperties": false
}
}
}
info.data_types
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name DataTypeClassesInfo
python_module_name kiara.models.values.data_type
full_name kiara.models.values.data_type.DataTypeClassesInfo
metadata_schema {
"title": "DataTypeClassesInfo",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"group_alias": {
"title": "Group Alias",
"description": "The group alias.",
"type": "string"
},
"type_name": {
"title": "Type Name",
"default": "data_type",
"enum": [
"data_type"
],
"type": "string"
},
"item_infos": {
"title": "Item Infos",
"description": "The data_type info instances for each type.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/DataTypeClassInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"DataTypeClassInfo": {
"title": "DataTypeClassInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"value_cls": {
"title": "Value Cls",
"description": "The python class of the value itself.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"data_type_config_cls": {
"title": "Data Type Config Cls",
"description": "The python class holding the schema for configuring this type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"lineage": {
"title": "Lineage",
"description": "This types lineage.",
"type": "array",
"items": {
"type": "string"
}
},
"qualifier_profiles": {
"title": "Qualifier Profiles",
"description": "A map of qualifier profiles for this data types.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"value_cls",
"data_type_config_cls"
],
"additionalProperties": false
}
}
}
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name MetadataTypeClassesInfo
python_module_name kiara.models.values.value_metadata
full_name kiara.models.values.value_metadata.MetadataTypeClassesInfo
metadata_schema {
"title": "MetadataTypeClassesInfo",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"group_alias": {
"title": "Group Alias",
"description": "The group alias.",
"type": "string"
},
"type_name": {
"title": "Type Name",
"default": "value_metadata",
"enum": [
"value_metadata"
],
"type": "string"
},
"item_infos": {
"title": "Item Infos",
"description": "The value metadata info instances for each type.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/MetadataTypeInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"MetadataTypeInfo": {
"title": "MetadataTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"metadata_schema": {
"title": "Metadata Schema",
"description": "The (json) schema for this metadata value.",
"type": "object"
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"metadata_schema"
],
"additionalProperties": false
}
}
}
info.archives
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ArchiveGroupInfo
python_module_name kiara.models.archives
full_name kiara.models.archives.ArchiveGroupInfo
metadata_schema {
"title": "ArchiveGroupInfo",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"group_alias": {
"title": "Group Alias",
"description": "The group alias.",
"type": "string"
},
"item_infos": {
"title": "Item Infos",
"description": "The info for each archive.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ArchiveInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"ArchiveTypeInfo": {
"title": "ArchiveTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"is_writable": {
"title": "Is Writable",
"description": "Whether this archive is writeable.",
"default": false,
"type": "boolean"
},
"supported_item_types": {
"title": "Supported Item Types",
"description": "The item types this archive suports.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"supported_item_types"
],
"additionalProperties": false
},
"ArchiveDetails": {
"title": "ArchiveDetails",
"type": "object",
"properties": {
"size": {
"title": "Size",
"description": "The size of the stored archive.",
"type": "integer"
}
}
},
"ArchiveInfo": {
"title": "ArchiveInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"archive_id": {
"title": "Archive Id",
"description": "The (globally unique) archive id.",
"type": "string",
"format": "uuid"
},
"archive_type_info": {
"title": "Archive Type Info",
"description": "Information about this archives' type.",
"allOf": [
{
"$ref": "#/definitions/ArchiveTypeInfo"
}
]
},
"config": {
"title": "Config",
"description": "The configuration of this archive.",
"type": "object"
},
"details": {
"title": "Details",
"description": "Type dependent (runtime) details for this archive.",
"allOf": [
{
"$ref": "#/definitions/ArchiveDetails"
}
]
},
"aliases": {
"title": "Aliases",
"description": "Aliases for this archive.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"archive_id",
"archive_type_info",
"config",
"details"
],
"additionalProperties": false
}
}
}
info.operations
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name OperationGroupInfo
python_module_name kiara.models.module.operation
full_name kiara.models.module.operation.OperationGroupInfo
metadata_schema {
"title": "OperationGroupInfo",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"group_alias": {
"title": "Group Alias",
"description": "The group alias.",
"type": "string"
},
"item_infos": {
"title": "Item Infos",
"description": "The operation info instances for each type.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/OperationInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"OperationDetails": {
"title": "OperationDetails",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"operation_id": {
"title": "Operation Id",
"description": "The id of the operation.",
"type": "string"
},
"is_internal_operation": {
"title": "Is Internal Operation",
"description": "Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation list…
"default": false,
"type": "boolean"
}
},
"required": [
"operation_id"
],
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"KiaraModuleClass": {
"title": "KiaraModuleClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"inputs_schema": {
"title": "Inputs Schema",
"description": "The schema for the module input(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"outputs_schema": {
"title": "Outputs Schema",
"description": "The schema for the module output(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name",
"module_config",
"inputs_schema",
"outputs_schema"
],
"additionalProperties": false
},
"Operation": {
"title": "Operation",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"operation_id": {
"title": "Operation Id",
"description": "The (unique) id of this operation.",
"type": "string"
},
"operation_details": {
"title": "Operation Details",
"description": "The operation specific details of this operation.",
"allOf": [
{
"$ref": "#/definitions/OperationDetails"
}
]
},
"doc": {
"title": "Doc",
"description": "Documentation for this operation.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"module_details": {
"title": "Module Details",
"description": "The class of the underlying module.",
"allOf": [
{
"$ref": "#/definitions/KiaraModuleClass"
}
]
},
"metadata": {
"title": "Metadata",
"description": "Additional metadata for this operation.",
"type": "object"
}
},
"required": [
"module_type",
"operation_id",
"operation_details",
"doc",
"module_details"
],
"additionalProperties": false
},
"OperationInfo": {
"title": "OperationInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"operation": {
"title": "Operation",
"description": "The operation instance.",
"allOf": [
{
"$ref": "#/definitions/Operation"
}
]
},
"operation_types": {
"title": "Operation Types",
"description": "The operation types this operation belongs to.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"operation",
"operation_types"
],
"additionalProperties": false
}
}
}
info.workflows
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name WorkflowGroupInfo
python_module_name kiara.models.workflow
full_name kiara.models.workflow.WorkflowGroupInfo
metadata_schema {
"title": "WorkflowGroupInfo",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"group_alias": {
"title": "Group Alias",
"description": "The group alias.",
"type": "string"
},
"item_infos": {
"title": "Item Infos",
"description": "The workflow infos objects for each workflow.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/WorkflowInfo"
}
},
"aliases": {
"title": "Aliases",
"description": "The available aliases.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"WorkflowDetails": {
"title": "WorkflowDetails",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"workflow_id": {
"title": "Workflow Id",
"description": "The globally unique uuid for this workflow.",
"type": "string",
"format": "uuid"
},
"documentation": {
"title": "Documentation",
"description": "A description for this workflow.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "The author(s) of this workflow.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Workflow context details.",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"current_state": {
"title": "Current State",
"description": "A reference to the current state of this workflow.",
"type": "string"
},
"workflow_states": {
"title": "Workflow States",
"description": "A history of all the states of this workflow.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"additionalProperties": false
},
"StepValueAddress": {
"title": "StepValueAddress",
"description": "Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure.",
"type": "object",
"properties": {
"step_id": {
"title": "Step Id",
"description": "The id of a step within a pipeline.",
"type": "string"
},
"value_name": {
"title": "Value Name",
"description": "The name of the value (output name or pipeline input name).",
"type": "string"
},
"sub_value": {
"title": "Sub Value",
"description": "A reference to a subitem of a value (e.g. column, list item)",
"type": "object"
}
},
"required": [
"step_id",
"value_name"
],
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"KiaraModuleClass": {
"title": "KiaraModuleClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"inputs_schema": {
"title": "Inputs Schema",
"description": "The schema for the module input(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"outputs_schema": {
"title": "Outputs Schema",
"description": "The schema for the module output(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name",
"module_config",
"inputs_schema",
"outputs_schema"
],
"additionalProperties": false
},
"PipelineStep": {
"title": "PipelineStep",
"description": "A step within a pipeline-structure, includes information about it's connection(s) and other metadat…
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"step_id": {
"title": "Step Id",
"description": "Locally unique id (within a pipeline) of this step.",
"type": "string"
},
"input_links": {
"title": "Input Links",
"description": "The links that connect to inputs of the module. Keys are field names, value(s) are connected ou…
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/StepValueAddress"
}
}
},
"module_details": {
"title": "Module Details",
"description": "The class of the underlying module.",
"allOf": [
{
"$ref": "#/definitions/KiaraModuleClass"
}
]
},
"doc": {
"title": "Doc",
"description": "A description what this step does.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"module_type",
"step_id",
"module_details",
"doc"
],
"additionalProperties": false
},
"PipelineConfig": {
"title": "PipelineConfig",
"description": "A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule].\n\n…
"type": "object",
"properties": {
"constants": {
"title": "Constants",
"description": "Value constants for this module.",
"type": "object"
},
"defaults": {
"title": "Defaults",
"description": "Value defaults for this module.",
"type": "object"
},
"pipeline_name": {
"title": "Pipeline Name",
"description": "The name of this pipeline.",
"type": "string"
},
"steps": {
"title": "Steps",
"description": "A list of steps/modules of this pipeline, and their connections.",
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"input_aliases": {
"title": "Input Aliases",
"description": "A map of input aliases, with the calculated (<step_id>__<input_name> -- double underscore!) nam…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"output_aliases": {
"title": "Output Aliases",
"description": "A map of output aliases, with the calculated (<step_id>__<output_name> -- double underscore!) n…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"doc": {
"title": "Doc",
"description": "Documentation about what the pipeline does.",
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Metadata for this workflow.",
"type": "object"
}
},
"required": [
"pipeline_name",
"steps",
"input_aliases",
"output_aliases"
]
},
"PipelineStructure": {
"title": "PipelineStructure",
"description": "An object that holds one or several steps, and describes the connections between them.",
"type": "object",
"properties": {
"pipeline_config": {
"title": "Pipeline Config",
"description": "The underlying pipeline config.",
"allOf": [
{
"$ref": "#/definitions/PipelineConfig"
}
]
},
"steps": {
"title": "Steps",
"description": "The pipeline steps ",
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"input_aliases": {
"title": "Input Aliases",
"description": "The input aliases.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"output_aliases": {
"title": "Output Aliases",
"description": "The output aliases.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"pipeline_config",
"steps",
"input_aliases",
"output_aliases"
],
"additionalProperties": false
},
"StepStatus": {
"title": "StepStatus",
"description": "Enum to describe the state of a workflow.",
"enum": [
"inputs_invalid",
"inputs_ready",
"results_ready"
]
},
"StepDetails": {
"title": "StepDetails",
"type": "object",
"properties": {
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context.",
"type": "string",
"format": "uuid"
},
"pipeline_id": {
"title": "Pipeline Id",
"description": "The id of the pipeline.",
"type": "string",
"format": "uuid"
},
"step": {
"title": "Step",
"description": "The pipeline step details.",
"allOf": [
{
"$ref": "#/definitions/PipelineStep"
}
]
},
"step_id": {
"title": "Step Id",
"description": "The id of the step.",
"type": "string"
},
"processing_stage": {
"title": "Processing Stage",
"description": "The execution stage where this step is executed.",
"type": "integer"
},
"status": {
"description": "The current status of this step.",
"allOf": [
{
"$ref": "#/definitions/StepStatus"
}
]
},
"invalid_details": {
"title": "Invalid Details",
"description": "Details about fields that are invalid (if status < 'INPUTS_READY'.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"inputs": {
"title": "Inputs",
"description": "The current inputs of this step.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"outputs": {
"title": "Outputs",
"description": "The current outputs of this step.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
}
},
"required": [
"kiara_id",
"pipeline_id",
"step",
"step_id",
"processing_stage",
"status",
"inputs",
"outputs"
]
},
"PipelineDetails": {
"title": "PipelineDetails",
"type": "object",
"properties": {
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context.",
"type": "string",
"format": "uuid"
},
"pipeline_id": {
"title": "Pipeline Id",
"description": "The id of the pipeline.",
"type": "string",
"format": "uuid"
},
"pipeline_status": {
"description": "The current status of this pipeline.",
"allOf": [
{
"$ref": "#/definitions/StepStatus"
}
]
},
"invalid_details": {
"title": "Invalid Details",
"description": "Details about fields that are invalid (if status < 'INPUTS_READY'.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"pipeline_inputs": {
"title": "Pipeline Inputs",
"description": "The current pipeline inputs.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"pipeline_outputs": {
"title": "Pipeline Outputs",
"description": "The current pipeline outputs.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"step_states": {
"title": "Step States",
"description": "The state of each step within this pipeline.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/StepDetails"
}
}
},
"required": [
"kiara_id",
"pipeline_id",
"pipeline_status",
"pipeline_inputs",
"pipeline_outputs",
"step_states"
]
},
"PipelineInfo": {
"title": "PipelineInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"pipeline_structure": {
"title": "Pipeline Structure",
"description": "The pipeline structure.",
"allOf": [
{
"$ref": "#/definitions/PipelineStructure"
}
]
},
"pipeline_details": {
"title": "Pipeline Details",
"description": "The current input details.",
"allOf": [
{
"$ref": "#/definitions/PipelineDetails"
}
]
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"pipeline_structure",
"pipeline_details"
],
"additionalProperties": false
},
"WorkflowState": {
"title": "WorkflowState",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"steps": {
"title": "Steps",
"description": "The current steps in the workflow.",
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"inputs": {
"title": "Inputs",
"description": "The current (pipeline) input values.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"pipeline_info": {
"title": "Pipeline Info",
"description": "Details about the pipeline and its state.",
"allOf": [
{
"$ref": "#/definitions/PipelineInfo"
}
]
}
},
"required": [
"pipeline_info"
],
"additionalProperties": false
},
"WorkflowInfo": {
"title": "WorkflowInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"workflow_details": {
"title": "Workflow Details",
"description": "The workflow details.",
"allOf": [
{
"$ref": "#/definitions/WorkflowDetails"
}
]
},
"workflow_states": {
"title": "Workflow States",
"description": "All states for this workflow.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/WorkflowState"
}
},
"pipeline_info": {
"title": "Pipeline Info",
"description": "The current state of the workflows' pipeline.",
"allOf": [
{
"$ref": "#/definitions/PipelineInfo"
}
]
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"workflow_details",
"workflow_states",
"pipeline_info"
],
"additionalProperties": false
}
}
}
instance.value_schema
Documentation
The schema of a value.
The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that
will be used if no user input was given (yet) for a value.
For more complex container data_types like array, tables, unions etc, data_types can also be configured with values
from the type_config field.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ValueSchema
python_module_name kiara.models.values.value_schema
full_name kiara.models.values.value_schema.ValueSchema
metadata_schema {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a v…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
}
}
}
instance.module_config
Documentation
Base class that describes the configuration a [KiaraModule][kiara.module.KiaraModule] class accepts.
This is stored in the _config_cls class attribute in each KiaraModule class.
There are two config options every KiaraModule supports:
• constants, and
• defaults
Constants are pre-set inputs, and users can't change them and an error is thrown if they try. Defaults are default
values that override the schema defaults, and those can be overwritten by users. If both a constant and a default
value is set for an input field, an error is thrown.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name KiaraModuleConfig
python_module_name kiara.models.module
full_name kiara.models.module.KiaraModuleConfig
metadata_schema {
"title": "KiaraModuleConfig",
"description": "Base class that describes the configuration a [``KiaraModule``][kiara.module.KiaraModule] class accepts…
"type": "object",
"properties": {
"constants": {
"title": "Constants",
"description": "Value constants for this module.",
"type": "object"
},
"defaults": {
"title": "Defaults",
"description": "Value defaults for this module.",
"type": "object"
}
},
"additionalProperties": false
}
instance.module_config.pipeline
Documentation
A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule].
If you want to control the pipeline input and output names, you need to have to provide a map that uses the
autogenerated field name ([step_id]__[alias] -- 2 underscores!!) as key, and the desired field name as value. The
reason that schema for the autogenerated field names exist is that it's hard to ensure the uniqueness of each field;
some steps can have the same input field names, but will need different input values. In some cases, some inputs of
different steps need the same input. Those sorts of things. So, to make sure that we always use the right values, I
chose to implement a conservative default approach, accepting that in some cases the user will be prompted for
duplicate inputs for the same value.
To remedy that, the pipeline creator has the option to manually specify a mapping to rename some or all of the
input/output fields.
Further, because in a lot of cases there won't be any overlapping fields, the creator can specify auto, in which case
Kiara will automatically create a mapping that tries to map autogenerated field names to the shortest possible names
for each case.
Examples:
┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Configuration for a pipeline module that functions as a ``nand`` logic gate (in Python): │
│ │
│ ``` python │
│ and_step = PipelineStepConfig(module_type="and", step_id="and") │
│ not_step = PipelineStepConfig(module_type="not", step_id="not", input_links={"a": ["and.y"]} │
│ nand_p_conf = PipelineConfig(doc="Returns 'False' if both inputs are 'True'.", │
│ steps=[and_step, not_step], │
│ input_aliases={ │
│ "and__a": "a", │
│ "and__b": "b" │
│ }, │
│ output_aliases={ │
│ "not__y": "y" │
│ }} │
│ ``` │
│ │
│ Or, the same thing in json: │
│ │
│ ``` json │
│ { │
│ "module_type_name": "nand", │
│ "doc": "Returns 'False' if both inputs are 'True'.", │
│ "steps": [ │
│ { │
│ "module_type": "and", │
│ "step_id": "and" │
│ }, │
│ { │
│ "module_type": "not", │
│ "step_id": "not", │
│ "input_links": { │
│ "a": "and.y" │
│ } │
│ } │
│ ], │
│ "input_aliases": { │
│ "and__a": "a", │
│ "and__b": "b" │
│ }, │
│ "output_aliases": { │
│ "not__y": "y" │
│ } │
│ } │
│ ``` │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name PipelineConfig
python_module_name kiara.models.module.pipeline
full_name kiara.models.module.pipeline.PipelineConfig
metadata_schema {
"title": "PipelineConfig",
"description": "A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule].\n\nIf y…
"type": "object",
"properties": {
"constants": {
"title": "Constants",
"description": "Value constants for this module.",
"type": "object"
},
"defaults": {
"title": "Defaults",
"description": "Value defaults for this module.",
"type": "object"
},
"pipeline_name": {
"title": "Pipeline Name",
"description": "The name of this pipeline.",
"type": "string"
},
"steps": {
"title": "Steps",
"description": "A list of steps/modules of this pipeline, and their connections.",
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"input_aliases": {
"title": "Input Aliases",
"description": "A map of input aliases, with the calculated (<step_id>__<input_name> -- double underscore!) name as…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"output_aliases": {
"title": "Output Aliases",
"description": "A map of output aliases, with the calculated (<step_id>__<output_name> -- double underscore!) name …
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"doc": {
"title": "Doc",
"description": "Documentation about what the pipeline does.",
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Metadata for this workflow.",
"type": "object"
}
},
"required": [
"pipeline_name",
"steps",
"input_aliases",
"output_aliases"
],
"definitions": {
"StepValueAddress": {
"title": "StepValueAddress",
"description": "Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure.",
"type": "object",
"properties": {
"step_id": {
"title": "Step Id",
"description": "The id of a step within a pipeline.",
"type": "string"
},
"value_name": {
"title": "Value Name",
"description": "The name of the value (output name or pipeline input name).",
"type": "string"
},
"sub_value": {
"title": "Sub Value",
"description": "A reference to a subitem of a value (e.g. column, list item)",
"type": "object"
}
},
"required": [
"step_id",
"value_name"
],
"additionalProperties": false
},
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"KiaraModuleClass": {
"title": "KiaraModuleClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"inputs_schema": {
"title": "Inputs Schema",
"description": "The schema for the module input(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"outputs_schema": {
"title": "Outputs Schema",
"description": "The schema for the module output(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name",
"module_config",
"inputs_schema",
"outputs_schema"
],
"additionalProperties": false
},
"PipelineStep": {
"title": "PipelineStep",
"description": "A step within a pipeline-structure, includes information about it's connection(s) and other metadat…
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"step_id": {
"title": "Step Id",
"description": "Locally unique id (within a pipeline) of this step.",
"type": "string"
},
"input_links": {
"title": "Input Links",
"description": "The links that connect to inputs of the module. Keys are field names, value(s) are connected ou…
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/StepValueAddress"
}
}
},
"module_details": {
"title": "Module Details",
"description": "The class of the underlying module.",
"allOf": [
{
"$ref": "#/definitions/KiaraModuleClass"
}
]
},
"doc": {
"title": "Doc",
"description": "A description what this step does.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"module_type",
"step_id",
"module_details",
"doc"
],
"additionalProperties": false
}
}
}
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name KiaraModuleConfigMetadata
python_module_name kiara.models.module
full_name kiara.models.module.KiaraModuleConfigMetadata
metadata_schema {
"title": "KiaraModuleConfigMetadata",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"python_class": {
"title": "Python Class",
"description": "The config model python class.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"config_values": {
"title": "Config Values",
"description": "The available configuration values.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueTypeAndDescription"
}
}
},
"required": [
"python_class",
"config_values"
],
"additionalProperties": false,
"definitions": {
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"ValueTypeAndDescription": {
"title": "ValueTypeAndDescription",
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "The description for the value.",
"type": "string"
},
"type": {
"title": "Type",
"description": "The value type.",
"type": "string"
},
"value_default": {
"title": "Value Default",
"description": "Default for the value."
},
"required": {
"title": "Required",
"description": "Whether this value is required",
"type": "boolean"
}
},
"required": [
"description",
"type",
"required"
]
}
}
}
instance.manifest
Documentation
A class to hold the type and configuration for a module instance.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name Manifest
python_module_name kiara.models.module.manifest
full_name kiara.models.module.manifest.Manifest
metadata_schema {
"title": "Manifest",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
}
},
"required": [
"module_type"
],
"additionalProperties": false
}
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name InputsManifest
python_module_name kiara.models.module.manifest
full_name kiara.models.module.manifest.InputsManifest
metadata_schema {
"title": "InputsManifest",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"inputs": {
"title": "Inputs",
"description": "A map of all the input fields and value references.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
}
},
"required": [
"module_type",
"inputs"
],
"additionalProperties": false
}
instance.value_pedigree
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ValuePedigree
python_module_name kiara.models.values.value
full_name kiara.models.values.value.ValuePedigree
metadata_schema {
"title": "ValuePedigree",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"inputs": {
"title": "Inputs",
"description": "A map of all the input fields and value references.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context a value was created in.",
"type": "string",
"format": "uuid"
},
"environments": {
"title": "Environments",
"description": "References to the runtime environment details a value was created in.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"module_type",
"inputs",
"kiara_id",
"environments"
],
"additionalProperties": false
}
instance.job_config
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name JobConfig
python_module_name kiara.models.module.jobs
full_name kiara.models.module.jobs.JobConfig
metadata_schema {
"title": "JobConfig",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"inputs": {
"title": "Inputs",
"description": "A map of all the input fields and value references.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
}
},
"required": [
"module_type",
"inputs"
],
"additionalProperties": false
}
instance.job_record
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name JobRecord
python_module_name kiara.models.module.jobs
full_name kiara.models.module.jobs.JobRecord
metadata_schema {
"title": "JobRecord",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"inputs": {
"title": "Inputs",
"description": "A map of all the input fields and value references.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"job_id": {
"title": "Job Id",
"description": "The globally unique id for this job.",
"type": "string",
"format": "uuid"
},
"environment_hashes": {
"title": "Environment Hashes",
"description": "Hashes for the environments this value was created in.",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"enviroments": {
"title": "Enviroments",
"description": "Information about the environments this value was created in.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"inputs_data_hash": {
"title": "Inputs Data Hash",
"description": "A map of the hashes of this jobs inputs.",
"type": "string"
},
"outputs": {
"title": "Outputs",
"description": "References to the job outputs.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"runtime_details": {
"title": "Runtime Details",
"description": "Runtime details for the job.",
"allOf": [
{
"$ref": "#/definitions/JobRuntimeDetails"
}
]
},
"job_metadata": {
"title": "Job Metadata",
"description": "Optional metadata for this job.",
"type": "object"
}
},
"required": [
"module_type",
"inputs",
"job_id",
"environment_hashes",
"outputs"
],
"additionalProperties": false,
"definitions": {
"LogMessage": {
"title": "LogMessage",
"type": "object",
"properties": {
"timestamp": {
"title": "Timestamp",
"description": "The time the message was logged.",
"type": "string",
"format": "date-time"
},
"log_level": {
"title": "Log Level",
"description": "The log level.",
"type": "integer"
},
"msg": {
"title": "Msg",
"description": "The log message",
"type": "string"
}
},
"required": [
"log_level",
"msg"
]
},
"JobLog": {
"title": "JobLog",
"type": "object",
"properties": {
"log": {
"title": "Log",
"description": "The logs for this job.",
"type": "array",
"items": {
"$ref": "#/definitions/LogMessage"
}
},
"percent_finished": {
"title": "Percent Finished",
"description": "Describes how much of the job is finished. A negative number means the module does not support …
"default": -1,
"type": "integer"
}
}
},
"JobRuntimeDetails": {
"title": "JobRuntimeDetails",
"type": "object",
"properties": {
"job_log": {
"title": "Job Log",
"description": "The lob jog.",
"allOf": [
{
"$ref": "#/definitions/JobLog"
}
]
},
"submitted": {
"title": "Submitted",
"description": "When the job was submitted.",
"type": "string",
"format": "date-time"
},
"started": {
"title": "Started",
"description": "When the job was started.",
"type": "string",
"format": "date-time"
},
"finished": {
"title": "Finished",
"description": "When the job was finished.",
"type": "string",
"format": "date-time"
},
"runtime": {
"title": "Runtime",
"description": "The duration of the job.",
"type": "number"
}
},
"required": [
"job_log",
"submitted",
"started",
"finished",
"runtime"
]
}
}
}
instance.pipeline_step
Documentation
A step within a pipeline-structure, includes information about it's connection(s) and other metadata.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name PipelineStep
python_module_name kiara.models.module.pipeline
full_name kiara.models.module.pipeline.PipelineStep
metadata_schema {
"title": "PipelineStep",
"description": "A step within a pipeline-structure, includes information about it's connection(s) and other metadata.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"step_id": {
"title": "Step Id",
"description": "Locally unique id (within a pipeline) of this step.",
"type": "string"
},
"input_links": {
"title": "Input Links",
"description": "The links that connect to inputs of the module. Keys are field names, value(s) are connected output…
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/StepValueAddress"
}
}
},
"module_details": {
"title": "Module Details",
"description": "The class of the underlying module.",
"allOf": [
{
"$ref": "#/definitions/KiaraModuleClass"
}
]
},
"doc": {
"title": "Doc",
"description": "A description what this step does.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"module_type",
"step_id",
"module_details",
"doc"
],
"additionalProperties": false,
"definitions": {
"StepValueAddress": {
"title": "StepValueAddress",
"description": "Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure.",
"type": "object",
"properties": {
"step_id": {
"title": "Step Id",
"description": "The id of a step within a pipeline.",
"type": "string"
},
"value_name": {
"title": "Value Name",
"description": "The name of the value (output name or pipeline input name).",
"type": "string"
},
"sub_value": {
"title": "Sub Value",
"description": "A reference to a subitem of a value (e.g. column, list item)",
"type": "object"
}
},
"required": [
"step_id",
"value_name"
],
"additionalProperties": false
},
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"KiaraModuleClass": {
"title": "KiaraModuleClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"inputs_schema": {
"title": "Inputs Schema",
"description": "The schema for the module input(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"outputs_schema": {
"title": "Outputs Schema",
"description": "The schema for the module output(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name",
"module_config",
"inputs_schema",
"outputs_schema"
],
"additionalProperties": false
}
}
}
instance.operation
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name Operation
python_module_name kiara.models.module.operation
full_name kiara.models.module.operation.Operation
metadata_schema {
"title": "Operation",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"operation_id": {
"title": "Operation Id",
"description": "The (unique) id of this operation.",
"type": "string"
},
"operation_details": {
"title": "Operation Details",
"description": "The operation specific details of this operation.",
"allOf": [
{
"$ref": "#/definitions/OperationDetails"
}
]
},
"doc": {
"title": "Doc",
"description": "Documentation for this operation.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"module_details": {
"title": "Module Details",
"description": "The class of the underlying module.",
"allOf": [
{
"$ref": "#/definitions/KiaraModuleClass"
}
]
},
"metadata": {
"title": "Metadata",
"description": "Additional metadata for this operation.",
"type": "object"
}
},
"required": [
"module_type",
"operation_id",
"operation_details",
"doc",
"module_details"
],
"additionalProperties": false,
"definitions": {
"OperationDetails": {
"title": "OperationDetails",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"operation_id": {
"title": "Operation Id",
"description": "The id of the operation.",
"type": "string"
},
"is_internal_operation": {
"title": "Is Internal Operation",
"description": "Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation list…
"default": false,
"type": "boolean"
}
},
"required": [
"operation_id"
],
"additionalProperties": false
},
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"KiaraModuleClass": {
"title": "KiaraModuleClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"inputs_schema": {
"title": "Inputs Schema",
"description": "The schema for the module input(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"outputs_schema": {
"title": "Outputs Schema",
"description": "The schema for the module output(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name",
"module_config",
"inputs_schema",
"outputs_schema"
],
"additionalProperties": false
}
}
}
instance.destiny
Documentation
A destiny is basically a link to a potential future transformation result involving one or several values as input.
It is immutable, once executed, each of the input values can only have one destiny with a specific alias. This is
similar to what is usually called a 'future' in programming languages, but more deterministic, sorta.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name Destiny
python_module_name kiara.models.module.destiniy
full_name kiara.models.module.destiniy.Destiny
metadata_schema {
"title": "Destiny",
"description": "A destiny is basically a link to a potential future transformation result involving one or several valu…
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"destiny_id": {
"title": "Destiny Id",
"description": "The id of this destiny.",
"type": "string",
"format": "uuid"
},
"destiny_alias": {
"title": "Destiny Alias",
"description": "The path to (the) destiny.",
"type": "string"
},
"module_details": {
"title": "Module Details",
"description": "The class of the underlying module.",
"allOf": [
{
"$ref": "#/definitions/KiaraModuleClass"
}
]
},
"fixed_inputs": {
"title": "Fixed Inputs",
"description": "Inputs that are known in advance.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"inputs_schema": {
"title": "Inputs Schema",
"description": "The schemas of all deferred input fields.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"deferred_inputs": {
"title": "Deferred Inputs",
"description": "Potentially required external inputs that are needed for this destiny to materialize.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"result_field_name": {
"title": "Result Field Name",
"description": "The name of the result field.",
"type": "string"
},
"result_schema": {
"title": "Result Schema",
"description": "The value schema of the result.",
"allOf": [
{
"$ref": "#/definitions/ValueSchema"
}
]
},
"result_value_id": {
"title": "Result Value Id",
"description": "The value id of the result.",
"type": "string",
"format": "uuid"
}
},
"required": [
"module_type",
"destiny_id",
"destiny_alias",
"module_details",
"fixed_inputs",
"inputs_schema",
"deferred_inputs",
"result_field_name",
"result_schema"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"KiaraModuleClass": {
"title": "KiaraModuleClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"inputs_schema": {
"title": "Inputs Schema",
"description": "The schema for the module input(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"outputs_schema": {
"title": "Outputs Schema",
"description": "The schema for the module output(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name",
"module_config",
"inputs_schema",
"outputs_schema"
],
"additionalProperties": false
}
}
}
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name SerializationMetadata
python_module_name kiara.models.values.value
full_name kiara.models.values.value.SerializationMetadata
metadata_schema {
"title": "SerializationMetadata",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"environment": {
"title": "Environment",
"description": "Hash(es) for the environments the value was created/serialized.",
"type": "object",
"additionalProperties": {
"type": "integer"
}
},
"deserialize": {
"title": "Deserialize",
"description": "Suggested manifest configs to use to de-serialize the data.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Manifest"
}
}
},
"additionalProperties": false,
"definitions": {
"Manifest": {
"title": "Manifest",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
}
},
"required": [
"module_type"
],
"additionalProperties": false
}
}
}
instance.serialization_result
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name SerializationResult
python_module_name kiara.models.values.value
full_name kiara.models.values.value.SerializationResult
metadata_schema {
"title": "SerializationResult",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"data_type": {
"title": "Data Type",
"description": "The name of the data type for this serialized value.",
"type": "string"
},
"data_type_config": {
"title": "Data Type Config",
"description": "The (optional) config for the data type for this serialized value.",
"type": "object"
},
"serialization_profile": {
"title": "Serialization Profile",
"description": "An identifying name for the serialization method used.",
"type": "string"
},
"metadata": {
"title": "Metadata",
"description": "Optional metadata describing aspects of the serialization used.",
"allOf": [
{
"$ref": "#/definitions/SerializationMetadata"
}
]
},
"hash_codec": {
"title": "Hash Codec",
"description": "The codec used to hash the value.",
"default": "sha2-256",
"type": "string"
},
"data": {
"title": "Data",
"description": "One or several byte arrays representing the serialized state of the value.",
"type": "object",
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/SerializedBytes"
},
{
"$ref": "#/definitions/SerializedListOfBytes"
},
{
"$ref": "#/definitions/SerializedFile"
},
{
"$ref": "#/definitions/SerializedFiles"
},
{
"$ref": "#/definitions/SerializedInlineJson"
}
]
}
}
},
"required": [
"data_type",
"serialization_profile",
"data"
],
"additionalProperties": false,
"definitions": {
"Manifest": {
"title": "Manifest",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
}
},
"required": [
"module_type"
],
"additionalProperties": false
},
"SerializationMetadata": {
"title": "SerializationMetadata",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"environment": {
"title": "Environment",
"description": "Hash(es) for the environments the value was created/serialized.",
"type": "object",
"additionalProperties": {
"type": "integer"
}
},
"deserialize": {
"title": "Deserialize",
"description": "Suggested manifest configs to use to de-serialize the data.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Manifest"
}
}
},
"additionalProperties": false
},
"SerializedBytes": {
"title": "SerializedBytes",
"type": "object",
"properties": {
"codec": {
"title": "Codec",
"description": "The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/m…
"type": "string"
},
"type": {
"title": "Type",
"default": "chunk",
"enum": [
"chunk"
],
"type": "string"
},
"chunk": {
"title": "Chunk",
"description": "A byte-array",
"type": "string",
"format": "binary"
}
},
"required": [
"codec",
"chunk"
],
"additionalProperties": false
},
"SerializedListOfBytes": {
"title": "SerializedListOfBytes",
"type": "object",
"properties": {
"codec": {
"title": "Codec",
"description": "The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/m…
"type": "string"
},
"type": {
"title": "Type",
"default": "chunks",
"enum": [
"chunks"
],
"type": "string"
},
"chunks": {
"title": "Chunks",
"description": "A list of byte arrays.",
"type": "array",
"items": {
"type": "string",
"format": "binary"
}
}
},
"required": [
"codec",
"chunks"
],
"additionalProperties": false
},
"SerializedFile": {
"title": "SerializedFile",
"type": "object",
"properties": {
"codec": {
"title": "Codec",
"description": "The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/m…
"type": "string"
},
"type": {
"title": "Type",
"default": "file",
"enum": [
"file"
],
"type": "string"
},
"file": {
"title": "File",
"description": "A path to a file containing the serialized data.",
"type": "string"
}
},
"required": [
"codec",
"file"
],
"additionalProperties": false
},
"SerializedFiles": {
"title": "SerializedFiles",
"type": "object",
"properties": {
"codec": {
"title": "Codec",
"description": "The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/m…
"type": "string"
},
"type": {
"title": "Type",
"default": "files",
"enum": [
"files"
],
"type": "string"
},
"files": {
"title": "Files",
"description": "A list of strings, pointing to files containing parts of the serialized data.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"codec",
"files"
],
"additionalProperties": false
},
"SerializedInlineJson": {
"title": "SerializedInlineJson",
"type": "object",
"properties": {
"codec": {
"title": "Codec",
"description": "The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/m…
"type": "string"
},
"type": {
"title": "Type",
"default": "inline-json",
"enum": [
"inline-json"
],
"type": "string"
},
"inline_data": {
"title": "Inline Data",
"description": "Data that will not be stored externally, but inline in the containing model. This should only c…
}
},
"required": [
"codec"
],
"additionalProperties": false
}
}
}
instance.persisted_data
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name PersistedData
python_module_name kiara.models.values.value
full_name kiara.models.values.value.PersistedData
metadata_schema {
"title": "PersistedData",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"data_type": {
"title": "Data Type",
"description": "The name of the data type for this serialized value.",
"type": "string"
},
"data_type_config": {
"title": "Data Type Config",
"description": "The (optional) config for the data type for this serialized value.",
"type": "object"
},
"serialization_profile": {
"title": "Serialization Profile",
"description": "An identifying name for the serialization method used.",
"type": "string"
},
"metadata": {
"title": "Metadata",
"description": "Optional metadata describing aspects of the serialization used.",
"allOf": [
{
"$ref": "#/definitions/SerializationMetadata"
}
]
},
"hash_codec": {
"title": "Hash Codec",
"description": "The codec used to hash the value.",
"default": "sha2-256",
"type": "string"
},
"archive_id": {
"title": "Archive Id",
"description": "The id of the store that persisted the data.",
"type": "string",
"format": "uuid"
},
"chunk_id_map": {
"title": "Chunk Id Map",
"description": "Reference-ids that resolve to the values' serialized chunks.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/SerializedChunkIDs"
}
}
},
"required": [
"data_type",
"serialization_profile",
"archive_id",
"chunk_id_map"
],
"additionalProperties": false,
"definitions": {
"Manifest": {
"title": "Manifest",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
}
},
"required": [
"module_type"
],
"additionalProperties": false
},
"SerializationMetadata": {
"title": "SerializationMetadata",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"environment": {
"title": "Environment",
"description": "Hash(es) for the environments the value was created/serialized.",
"type": "object",
"additionalProperties": {
"type": "integer"
}
},
"deserialize": {
"title": "Deserialize",
"description": "Suggested manifest configs to use to de-serialize the data.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Manifest"
}
}
},
"additionalProperties": false
},
"SerializedChunkIDs": {
"title": "SerializedChunkIDs",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "chunk-ids",
"enum": [
"chunk-ids"
],
"type": "string"
},
"chunk_id_list": {
"title": "Chunk Id List",
"description": "A list of chunk ids, which will be resolved via the attached data registry.",
"type": "array",
"items": {
"type": "string"
}
},
"archive_id": {
"title": "Archive Id",
"description": "The preferred data archive to get the chunks from.",
"type": "string",
"format": "uuid"
},
"size": {
"title": "Size",
"description": "The size of all chunks combined.",
"type": "integer"
}
},
"required": [
"chunk_id_list",
"size"
],
"additionalProperties": false
}
}
}
instance.value_details
Documentation
A wrapper class that manages and retieves value data and its details.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ValueDetails
python_module_name kiara.models.values.value
full_name kiara.models.values.value.ValueDetails
metadata_schema {
"title": "ValueDetails",
"description": "A wrapper class that manages and retieves value data and its details.",
"type": "object",
"properties": {
"value_id": {
"title": "Value Id",
"description": "The id of the value.",
"type": "string",
"format": "uuid"
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context this value belongs to.",
"type": "string",
"format": "uuid"
},
"value_schema": {
"title": "Value Schema",
"description": "The schema that was used for this Value.",
"allOf": [
{
"$ref": "#/definitions/ValueSchema"
}
]
},
"value_status": {
"description": "The set/unset status of this value.",
"allOf": [
{
"$ref": "#/definitions/ValueStatus"
}
]
},
"value_size": {
"title": "Value Size",
"description": "The size of this value, in bytes.",
"type": "integer"
},
"value_hash": {
"title": "Value Hash",
"description": "The hash of this value.",
"type": "string"
},
"pedigree": {
"title": "Pedigree",
"description": "Information about the module and inputs that went into creating this value.",
"allOf": [
{
"$ref": "#/definitions/ValuePedigree"
}
]
},
"pedigree_output_name": {
"title": "Pedigree Output Name",
"description": "The output name that produced this value (using the manifest inside the pedigree).",
"type": "string"
},
"data_type_class": {
"title": "Data Type Class",
"description": "The python class that is associtated with this model.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
}
},
"required": [
"value_id",
"kiara_id",
"value_schema",
"value_status",
"value_size",
"value_hash",
"pedigree",
"pedigree_output_name",
"data_type_class"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"ValueStatus": {
"title": "ValueStatus",
"description": "An enumeration.",
"enum": [
"unknown",
"not set",
"none",
"default",
"set"
]
},
"ValuePedigree": {
"title": "ValuePedigree",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"inputs": {
"title": "Inputs",
"description": "A map of all the input fields and value references.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context a value was created in.",
"type": "string",
"format": "uuid"
},
"environments": {
"title": "Environments",
"description": "References to the runtime environment details a value was created in.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"module_type",
"inputs",
"kiara_id",
"environments"
],
"additionalProperties": false
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
}
}
}
instance.value
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name Value
python_module_name kiara.models.values.value
full_name kiara.models.values.value.Value
metadata_schema {
"title": "Value",
"description": "A wrapper class that manages and retieves value data and its details.",
"type": "object",
"properties": {
"value_id": {
"title": "Value Id",
"description": "The id of the value.",
"type": "string",
"format": "uuid"
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context this value belongs to.",
"type": "string",
"format": "uuid"
},
"value_schema": {
"title": "Value Schema",
"description": "The schema that was used for this Value.",
"allOf": [
{
"$ref": "#/definitions/ValueSchema"
}
]
},
"value_status": {
"description": "The set/unset status of this value.",
"allOf": [
{
"$ref": "#/definitions/ValueStatus"
}
]
},
"value_size": {
"title": "Value Size",
"description": "The size of this value, in bytes.",
"type": "integer"
},
"value_hash": {
"title": "Value Hash",
"description": "The hash of this value.",
"type": "string"
},
"pedigree": {
"title": "Pedigree",
"description": "Information about the module and inputs that went into creating this value.",
"allOf": [
{
"$ref": "#/definitions/ValuePedigree"
}
]
},
"pedigree_output_name": {
"title": "Pedigree Output Name",
"description": "The output name that produced this value (using the manifest inside the pedigree).",
"type": "string"
},
"data_type_class": {
"title": "Data Type Class",
"description": "The python class that is associtated with this model.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"environment_hashes": {
"title": "Environment Hashes",
"description": "Hashes for the environments this value was created in.",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"enviroments": {
"title": "Enviroments",
"description": "Information about the environments this value was created in.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"property_links": {
"title": "Property Links",
"description": "Links to values that are properties of this value.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"destiny_backlinks": {
"title": "Destiny Backlinks",
"description": "Backlinks to values that this value acts as destiny/or property for.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"value_id",
"kiara_id",
"value_schema",
"value_status",
"value_size",
"value_hash",
"pedigree",
"pedigree_output_name",
"data_type_class",
"environment_hashes"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"ValueStatus": {
"title": "ValueStatus",
"description": "An enumeration.",
"enum": [
"unknown",
"not set",
"none",
"default",
"set"
]
},
"ValuePedigree": {
"title": "ValuePedigree",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"inputs": {
"title": "Inputs",
"description": "A map of all the input fields and value references.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context a value was created in.",
"type": "string",
"format": "uuid"
},
"environments": {
"title": "Environments",
"description": "References to the runtime environment details a value was created in.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"module_type",
"inputs",
"kiara_id",
"environments"
],
"additionalProperties": false
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
}
}
}
info.value
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ValueInfo
python_module_name kiara.models.values.info
full_name kiara.models.values.info.ValueInfo
metadata_schema {
"title": "ValueInfo",
"description": "A wrapper class that manages and retieves value data and its details.",
"type": "object",
"properties": {
"value_id": {
"title": "Value Id",
"description": "The value id.",
"type": "string",
"format": "uuid"
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context this value belongs to.",
"type": "string",
"format": "uuid"
},
"value_schema": {
"title": "Value Schema",
"description": "The data schema of this value.",
"allOf": [
{
"$ref": "#/definitions/ValueSchema"
}
]
},
"value_status": {
"description": "The set/unset status of this value.",
"allOf": [
{
"$ref": "#/definitions/ValueStatus"
}
]
},
"value_size": {
"title": "Value Size",
"description": "The size of this value, in bytes.",
"type": "integer"
},
"value_hash": {
"title": "Value Hash",
"description": "The hash of this value.",
"type": "string"
},
"pedigree": {
"title": "Pedigree",
"description": "Information about the module and inputs that went into creating this value.",
"allOf": [
{
"$ref": "#/definitions/ValuePedigree"
}
]
},
"pedigree_output_name": {
"title": "Pedigree Output Name",
"description": "The output name that produced this value (using the manifest inside the pedigree).",
"type": "string"
},
"data_type_class": {
"title": "Data Type Class",
"description": "The python class that is associtated with this model.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"environment_hashes": {
"title": "Environment Hashes",
"description": "Hashes for the environments this value was created in.",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"enviroments": {
"title": "Enviroments",
"description": "Information about the environments this value was created in.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"property_links": {
"title": "Property Links",
"description": "Links to values that are properties of this value.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"destiny_backlinks": {
"title": "Destiny Backlinks",
"description": "Backlinks to values that this value acts as destiny/or property for.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"aliases": {
"title": "Aliases",
"description": "The aliases that are registered for this value.",
"type": "array",
"items": {
"type": "string"
}
},
"serialized": {
"title": "Serialized",
"description": "Details for the serialization process that was used for this value.",
"allOf": [
{
"$ref": "#/definitions/PersistedData"
}
]
},
"destiny_links": {
"title": "Destiny Links",
"description": "References to all the values that act as destiny for this value in this context.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
}
},
"required": [
"value_id",
"kiara_id",
"value_schema",
"value_status",
"value_size",
"value_hash",
"pedigree",
"pedigree_output_name",
"data_type_class",
"environment_hashes"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"ValueStatus": {
"title": "ValueStatus",
"description": "An enumeration.",
"enum": [
"unknown",
"not set",
"none",
"default",
"set"
]
},
"ValuePedigree": {
"title": "ValuePedigree",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"inputs": {
"title": "Inputs",
"description": "A map of all the input fields and value references.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context a value was created in.",
"type": "string",
"format": "uuid"
},
"environments": {
"title": "Environments",
"description": "References to the runtime environment details a value was created in.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"module_type",
"inputs",
"kiara_id",
"environments"
],
"additionalProperties": false
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"Manifest": {
"title": "Manifest",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
}
},
"required": [
"module_type"
],
"additionalProperties": false
},
"SerializationMetadata": {
"title": "SerializationMetadata",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"environment": {
"title": "Environment",
"description": "Hash(es) for the environments the value was created/serialized.",
"type": "object",
"additionalProperties": {
"type": "integer"
}
},
"deserialize": {
"title": "Deserialize",
"description": "Suggested manifest configs to use to de-serialize the data.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Manifest"
}
}
},
"additionalProperties": false
},
"SerializedChunkIDs": {
"title": "SerializedChunkIDs",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "chunk-ids",
"enum": [
"chunk-ids"
],
"type": "string"
},
"chunk_id_list": {
"title": "Chunk Id List",
"description": "A list of chunk ids, which will be resolved via the attached data registry.",
"type": "array",
"items": {
"type": "string"
}
},
"archive_id": {
"title": "Archive Id",
"description": "The preferred data archive to get the chunks from.",
"type": "string",
"format": "uuid"
},
"size": {
"title": "Size",
"description": "The size of all chunks combined.",
"type": "integer"
}
},
"required": [
"chunk_id_list",
"size"
],
"additionalProperties": false
},
"PersistedData": {
"title": "PersistedData",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"data_type": {
"title": "Data Type",
"description": "The name of the data type for this serialized value.",
"type": "string"
},
"data_type_config": {
"title": "Data Type Config",
"description": "The (optional) config for the data type for this serialized value.",
"type": "object"
},
"serialization_profile": {
"title": "Serialization Profile",
"description": "An identifying name for the serialization method used.",
"type": "string"
},
"metadata": {
"title": "Metadata",
"description": "Optional metadata describing aspects of the serialization used.",
"allOf": [
{
"$ref": "#/definitions/SerializationMetadata"
}
]
},
"hash_codec": {
"title": "Hash Codec",
"description": "The codec used to hash the value.",
"default": "sha2-256",
"type": "string"
},
"archive_id": {
"title": "Archive Id",
"description": "The id of the store that persisted the data.",
"type": "string",
"format": "uuid"
},
"chunk_id_map": {
"title": "Chunk Id Map",
"description": "Reference-ids that resolve to the values' serialized chunks.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/SerializedChunkIDs"
}
}
},
"required": [
"data_type",
"serialization_profile",
"archive_id",
"chunk_id_map"
],
"additionalProperties": false
}
}
}
instance.unloadable_data
Documentation
A special 'marker' model, indicating that the data of value can't be loaded.
In most cases, the reason this happens is because the current kiara context is missing some value types and/or
modules.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name UnloadableData
python_module_name kiara.models.values.value
full_name kiara.models.values.value.UnloadableData
metadata_schema {
"title": "UnloadableData",
"description": "A special 'marker' model, indicating that the data of value can't be loaded.\n\nIn most cases, the reas…
"type": "object",
"properties": {
"value": {
"title": "Value",
"description": "A reference to the value.",
"allOf": [
{
"$ref": "#/definitions/Value"
}
]
}
},
"required": [
"value"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"ValueStatus": {
"title": "ValueStatus",
"description": "An enumeration.",
"enum": [
"unknown",
"not set",
"none",
"default",
"set"
]
},
"ValuePedigree": {
"title": "ValuePedigree",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"inputs": {
"title": "Inputs",
"description": "A map of all the input fields and value references.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context a value was created in.",
"type": "string",
"format": "uuid"
},
"environments": {
"title": "Environments",
"description": "References to the runtime environment details a value was created in.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"module_type",
"inputs",
"kiara_id",
"environments"
],
"additionalProperties": false
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"Value": {
"title": "Value",
"description": "A wrapper class that manages and retieves value data and its details.",
"type": "object",
"properties": {
"value_id": {
"title": "Value Id",
"description": "The id of the value.",
"type": "string",
"format": "uuid"
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context this value belongs to.",
"type": "string",
"format": "uuid"
},
"value_schema": {
"title": "Value Schema",
"description": "The schema that was used for this Value.",
"allOf": [
{
"$ref": "#/definitions/ValueSchema"
}
]
},
"value_status": {
"description": "The set/unset status of this value.",
"allOf": [
{
"$ref": "#/definitions/ValueStatus"
}
]
},
"value_size": {
"title": "Value Size",
"description": "The size of this value, in bytes.",
"type": "integer"
},
"value_hash": {
"title": "Value Hash",
"description": "The hash of this value.",
"type": "string"
},
"pedigree": {
"title": "Pedigree",
"description": "Information about the module and inputs that went into creating this value.",
"allOf": [
{
"$ref": "#/definitions/ValuePedigree"
}
]
},
"pedigree_output_name": {
"title": "Pedigree Output Name",
"description": "The output name that produced this value (using the manifest inside the pedigree).",
"type": "string"
},
"data_type_class": {
"title": "Data Type Class",
"description": "The python class that is associtated with this model.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"environment_hashes": {
"title": "Environment Hashes",
"description": "Hashes for the environments this value was created in.",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"enviroments": {
"title": "Enviroments",
"description": "Information about the environments this value was created in.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"property_links": {
"title": "Property Links",
"description": "Links to values that are properties of this value.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"destiny_backlinks": {
"title": "Destiny Backlinks",
"description": "Backlinks to values that this value acts as destiny/or property for.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"value_id",
"kiara_id",
"value_schema",
"value_status",
"value_size",
"value_hash",
"pedigree",
"pedigree_output_name",
"data_type_class",
"environment_hashes"
],
"additionalProperties": false
}
}
}
instance.value_map.readonly
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ValueMapReadOnly
python_module_name kiara.models.values.value
full_name kiara.models.values.value.ValueMapReadOnly
metadata_schema {
"title": "ValueMapReadOnly",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"values_schema": {
"title": "Values Schema",
"description": "The schemas for all the values in this set.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"value_items": {
"title": "Value Items",
"description": "The values contained in this set.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Value"
}
}
},
"required": [
"values_schema",
"value_items"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"ValueStatus": {
"title": "ValueStatus",
"description": "An enumeration.",
"enum": [
"unknown",
"not set",
"none",
"default",
"set"
]
},
"ValuePedigree": {
"title": "ValuePedigree",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"inputs": {
"title": "Inputs",
"description": "A map of all the input fields and value references.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context a value was created in.",
"type": "string",
"format": "uuid"
},
"environments": {
"title": "Environments",
"description": "References to the runtime environment details a value was created in.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"module_type",
"inputs",
"kiara_id",
"environments"
],
"additionalProperties": false
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"Value": {
"title": "Value",
"description": "A wrapper class that manages and retieves value data and its details.",
"type": "object",
"properties": {
"value_id": {
"title": "Value Id",
"description": "The id of the value.",
"type": "string",
"format": "uuid"
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context this value belongs to.",
"type": "string",
"format": "uuid"
},
"value_schema": {
"title": "Value Schema",
"description": "The schema that was used for this Value.",
"allOf": [
{
"$ref": "#/definitions/ValueSchema"
}
]
},
"value_status": {
"description": "The set/unset status of this value.",
"allOf": [
{
"$ref": "#/definitions/ValueStatus"
}
]
},
"value_size": {
"title": "Value Size",
"description": "The size of this value, in bytes.",
"type": "integer"
},
"value_hash": {
"title": "Value Hash",
"description": "The hash of this value.",
"type": "string"
},
"pedigree": {
"title": "Pedigree",
"description": "Information about the module and inputs that went into creating this value.",
"allOf": [
{
"$ref": "#/definitions/ValuePedigree"
}
]
},
"pedigree_output_name": {
"title": "Pedigree Output Name",
"description": "The output name that produced this value (using the manifest inside the pedigree).",
"type": "string"
},
"data_type_class": {
"title": "Data Type Class",
"description": "The python class that is associtated with this model.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"environment_hashes": {
"title": "Environment Hashes",
"description": "Hashes for the environments this value was created in.",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"enviroments": {
"title": "Enviroments",
"description": "Information about the environments this value was created in.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"property_links": {
"title": "Property Links",
"description": "Links to values that are properties of this value.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"destiny_backlinks": {
"title": "Destiny Backlinks",
"description": "Backlinks to values that this value acts as destiny/or property for.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"value_id",
"kiara_id",
"value_schema",
"value_status",
"value_size",
"value_hash",
"pedigree",
"pedigree_output_name",
"data_type_class",
"environment_hashes"
],
"additionalProperties": false
}
}
}
instance.value_map.writeable
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ValueMapWritable
python_module_name kiara.models.values.value
full_name kiara.models.values.value.ValueMapWritable
metadata_schema {
"title": "ValueMapWritable",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"values_schema": {
"title": "Values Schema",
"description": "The schemas for all the values in this set.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"value_items": {
"title": "Value Items",
"description": "The values contained in this set.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Value"
}
},
"pedigree": {
"title": "Pedigree",
"description": "The pedigree to add to all of the result values.",
"allOf": [
{
"$ref": "#/definitions/ValuePedigree"
}
]
},
"unique_value_ids": {
"title": "Unique Value Ids",
"description": "Whether this value map always creates new value(id)s, even when a dataset with matching hash is fou…
"default": true,
"type": "boolean"
}
},
"required": [
"values_schema",
"pedigree"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"ValueStatus": {
"title": "ValueStatus",
"description": "An enumeration.",
"enum": [
"unknown",
"not set",
"none",
"default",
"set"
]
},
"ValuePedigree": {
"title": "ValuePedigree",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"inputs": {
"title": "Inputs",
"description": "A map of all the input fields and value references.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context a value was created in.",
"type": "string",
"format": "uuid"
},
"environments": {
"title": "Environments",
"description": "References to the runtime environment details a value was created in.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"module_type",
"inputs",
"kiara_id",
"environments"
],
"additionalProperties": false
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"Value": {
"title": "Value",
"description": "A wrapper class that manages and retieves value data and its details.",
"type": "object",
"properties": {
"value_id": {
"title": "Value Id",
"description": "The id of the value.",
"type": "string",
"format": "uuid"
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context this value belongs to.",
"type": "string",
"format": "uuid"
},
"value_schema": {
"title": "Value Schema",
"description": "The schema that was used for this Value.",
"allOf": [
{
"$ref": "#/definitions/ValueSchema"
}
]
},
"value_status": {
"description": "The set/unset status of this value.",
"allOf": [
{
"$ref": "#/definitions/ValueStatus"
}
]
},
"value_size": {
"title": "Value Size",
"description": "The size of this value, in bytes.",
"type": "integer"
},
"value_hash": {
"title": "Value Hash",
"description": "The hash of this value.",
"type": "string"
},
"pedigree": {
"title": "Pedigree",
"description": "Information about the module and inputs that went into creating this value.",
"allOf": [
{
"$ref": "#/definitions/ValuePedigree"
}
]
},
"pedigree_output_name": {
"title": "Pedigree Output Name",
"description": "The output name that produced this value (using the manifest inside the pedigree).",
"type": "string"
},
"data_type_class": {
"title": "Data Type Class",
"description": "The python class that is associtated with this model.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"environment_hashes": {
"title": "Environment Hashes",
"description": "Hashes for the environments this value was created in.",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"enviroments": {
"title": "Enviroments",
"description": "Information about the environments this value was created in.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"property_links": {
"title": "Property Links",
"description": "Links to values that are properties of this value.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"destiny_backlinks": {
"title": "Destiny Backlinks",
"description": "Backlinks to values that this value acts as destiny/or property for.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"value_id",
"kiara_id",
"value_schema",
"value_status",
"value_size",
"value_hash",
"pedigree",
"pedigree_output_name",
"data_type_class",
"environment_hashes"
],
"additionalProperties": false
}
}
}
instance.value_map.aliases
Documentation
A model class that holds a tree of values and their schemas.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name AliasValueMap
python_module_name kiara.models.aliases
full_name kiara.models.aliases.AliasValueMap
metadata_schema {
"$ref": "#/definitions/AliasValueMap",
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"AliasValueMap": {
"title": "AliasValueMap",
"description": "A model class that holds a tree of values and their schemas.",
"type": "object",
"properties": {
"values_schema": {
"title": "Values Schema",
"description": "The schemas for all the values in this set.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"alias": {
"title": "Alias",
"description": "This maps own (full) alias.",
"type": "string"
},
"version": {
"title": "Version",
"description": "The version of this map (in this maps parent).",
"type": "integer"
},
"created": {
"title": "Created",
"description": "The time this map was created.",
"type": "string",
"format": "date-time"
},
"assoc_schema": {
"title": "Assoc Schema",
"description": "The schema for this maps associated value.",
"allOf": [
{
"$ref": "#/definitions/ValueSchema"
}
]
},
"assoc_value": {
"title": "Assoc Value",
"description": "The value that is associated with this map.",
"type": "string",
"format": "uuid"
},
"value_items": {
"title": "Value Items",
"description": "The values contained in this set.",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AliasValueMap"
}
}
}
},
"required": [
"values_schema",
"version"
],
"additionalProperties": false
}
}
}
info.runtime.kiara_types
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name KiaraTypesRuntimeEnvironment
python_module_name kiara.models.runtime_environment.kiara
full_name kiara.models.runtime_environment.kiara.KiaraTypesRuntimeEnvironment
metadata_schema {
"title": "KiaraTypesRuntimeEnvironment",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"environment_type": {
"title": "Environment Type",
"enum": [
"kiara_types"
],
"type": "string"
},
"archive_types": {
"title": "Archive Types",
"description": "The available implemented store types.",
"allOf": [
{
"$ref": "#/definitions/ArchiveTypeClassesInfo"
}
]
},
"metadata_types": {
"title": "Metadata Types",
"description": "The available metadata types.",
"allOf": [
{
"$ref": "#/definitions/MetadataTypeClassesInfo"
}
]
}
},
"required": [
"environment_type",
"archive_types",
"metadata_types"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"ArchiveTypeInfo": {
"title": "ArchiveTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"is_writable": {
"title": "Is Writable",
"description": "Whether this archive is writeable.",
"default": false,
"type": "boolean"
},
"supported_item_types": {
"title": "Supported Item Types",
"description": "The item types this archive suports.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"supported_item_types"
],
"additionalProperties": false
},
"ArchiveTypeClassesInfo": {
"title": "ArchiveTypeClassesInfo",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"group_alias": {
"title": "Group Alias",
"description": "The group alias.",
"type": "string"
},
"type_name": {
"title": "Type Name",
"default": "archive_type",
"enum": [
"archive_type"
],
"type": "string"
},
"item_infos": {
"title": "Item Infos",
"description": "The archive info instances for each type.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ArchiveTypeInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false
},
"MetadataTypeInfo": {
"title": "MetadataTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"metadata_schema": {
"title": "Metadata Schema",
"description": "The (json) schema for this metadata value.",
"type": "object"
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"metadata_schema"
],
"additionalProperties": false
},
"MetadataTypeClassesInfo": {
"title": "MetadataTypeClassesInfo",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"group_alias": {
"title": "Group Alias",
"description": "The group alias.",
"type": "string"
},
"type_name": {
"title": "Type Name",
"default": "value_metadata",
"enum": [
"value_metadata"
],
"type": "string"
},
"item_infos": {
"title": "Item Infos",
"description": "The value metadata info instances for each type.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/MetadataTypeInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false
}
}
}
info.runtime.os
Documentation
Manages information about the OS this kiara instance is running in.
╔════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╗
║ TODO: details for other OS's (mainly BSDs) ║
╚════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╝
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name OSRuntimeEnvironment
python_module_name kiara.models.runtime_environment.operating_system
full_name kiara.models.runtime_environment.operating_system.OSRuntimeEnvironment
metadata_schema {
"title": "OSRuntimeEnvironment",
"description": "Manages information about the OS this kiara instance is running in.\n\n# TODO: details for other OS's (…
"type": "object",
"properties": {
"environment_type": {
"title": "Environment Type",
"enum": [
"operating_system"
],
"type": "string"
},
"operation_system": {
"title": "Operation System",
"description": "The operation system name.",
"type": "string"
},
"platform": {
"title": "Platform",
"description": "The platform name.",
"type": "string"
},
"release": {
"title": "Release",
"description": "The platform release name.",
"type": "string"
},
"version": {
"title": "Version",
"description": "The platform version name.",
"type": "string"
},
"machine": {
"title": "Machine",
"description": "The architecture.",
"type": "string"
},
"os_specific": {
"title": "Os Specific",
"description": "OS specific platform metadata.",
"type": "object"
}
},
"required": [
"environment_type",
"operation_system",
"platform",
"release",
"version",
"machine"
],
"additionalProperties": false
}
info.runtime.python
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name PythonRuntimeEnvironment
python_module_name kiara.models.runtime_environment.python
full_name kiara.models.runtime_environment.python.PythonRuntimeEnvironment
metadata_schema {
"title": "PythonRuntimeEnvironment",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"environment_type": {
"title": "Environment Type",
"enum": [
"python"
],
"type": "string"
},
"python_version": {
"title": "Python Version",
"description": "The version of Python.",
"type": "string"
},
"packages": {
"title": "Packages",
"description": "The packages installed in the Python (virtual) environment.",
"type": "array",
"items": {
"$ref": "#/definitions/PythonPackage"
}
}
},
"required": [
"environment_type",
"python_version",
"packages"
],
"additionalProperties": false,
"definitions": {
"PythonPackage": {
"title": "PythonPackage",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The name of the Python package.",
"type": "string"
},
"version": {
"title": "Version",
"description": "The version of the package.",
"type": "string"
}
},
"required": [
"name",
"version"
]
}
}
}
info.runtime.kiara_plugins
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name KiaraPluginsRuntimeEnvironment
python_module_name kiara.models.runtime_environment.python
full_name kiara.models.runtime_environment.python.KiaraPluginsRuntimeEnvironment
metadata_schema {
"title": "KiaraPluginsRuntimeEnvironment",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"environment_type": {
"title": "Environment Type",
"enum": [
"kiara_plugins"
],
"type": "string"
},
"kiara_plugins": {
"title": "Kiara Plugins",
"description": "The kiara plugin packages installed in the Python (virtual) environment.",
"type": "array",
"items": {
"$ref": "#/definitions/PythonPackage"
}
}
},
"required": [
"environment_type",
"kiara_plugins"
],
"additionalProperties": false,
"definitions": {
"PythonPackage": {
"title": "PythonPackage",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The name of the Python package.",
"type": "string"
},
"version": {
"title": "Version",
"description": "The version of the package.",
"type": "string"
}
},
"required": [
"name",
"version"
]
}
}
}
context_summary
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ContextSummary
python_module_name kiara.models.context
full_name kiara.models.context.ContextSummary
metadata_schema {
"title": "ContextSummary",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"kiara_id": {
"title": "Kiara Id",
"description": "The (globally unique) id of the kiara context.",
"type": "string",
"format": "uuid"
},
"context_name": {
"title": "Context Name",
"description": "The local alias for this context.",
"type": "string"
},
"value_ids": {
"title": "Value Ids",
"description": "The ids of all stored values in this context.",
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"aliases": {
"title": "Aliases",
"description": "All available aliases within this context (and the value ids they refer to).",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"archives": {
"title": "Archives",
"description": "The archives registered in this context.",
"allOf": [
{
"$ref": "#/definitions/ArchiveGroupInfo"
}
]
}
},
"required": [
"kiara_id",
"value_ids",
"aliases",
"archives"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
},
"ArchiveTypeInfo": {
"title": "ArchiveTypeInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this module type.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"is_writable": {
"title": "Is Writable",
"description": "Whether this archive is writeable.",
"default": false,
"type": "boolean"
},
"supported_item_types": {
"title": "Supported Item Types",
"description": "The item types this archive suports.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"python_class",
"supported_item_types"
],
"additionalProperties": false
},
"ArchiveDetails": {
"title": "ArchiveDetails",
"type": "object",
"properties": {
"size": {
"title": "Size",
"description": "The size of the stored archive.",
"type": "integer"
}
}
},
"ArchiveInfo": {
"title": "ArchiveInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"archive_id": {
"title": "Archive Id",
"description": "The (globally unique) archive id.",
"type": "string",
"format": "uuid"
},
"archive_type_info": {
"title": "Archive Type Info",
"description": "Information about this archives' type.",
"allOf": [
{
"$ref": "#/definitions/ArchiveTypeInfo"
}
]
},
"config": {
"title": "Config",
"description": "The configuration of this archive.",
"type": "object"
},
"details": {
"title": "Details",
"description": "Type dependent (runtime) details for this archive.",
"allOf": [
{
"$ref": "#/definitions/ArchiveDetails"
}
]
},
"aliases": {
"title": "Aliases",
"description": "Aliases for this archive.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"archive_id",
"archive_type_info",
"config",
"details"
],
"additionalProperties": false
},
"ArchiveGroupInfo": {
"title": "ArchiveGroupInfo",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"group_alias": {
"title": "Group Alias",
"description": "The group alias.",
"type": "string"
},
"item_infos": {
"title": "Item Infos",
"description": "The info for each archive.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ArchiveInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false
}
}
}
instance.execution_context
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ExecutionContext
python_module_name kiara.models.module.jobs
full_name kiara.models.module.jobs.ExecutionContext
metadata_schema {
"title": "ExecutionContext",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"working_dir": {
"title": "Working Dir",
"description": "The path of the working directory.",
"type": "string"
},
"pipeline_dir": {
"title": "Pipeline Dir",
"description": "The path of the pipeline file that is being executed (if applicable).",
"type": "string"
}
},
"additionalProperties": false
}
instance.active_job
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ActiveJob
python_module_name kiara.models.module.jobs
full_name kiara.models.module.jobs.ActiveJob
metadata_schema {
"title": "ActiveJob",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"job_id": {
"title": "Job Id",
"description": "The job id.",
"type": "string",
"format": "uuid"
},
"job_config": {
"title": "Job Config",
"description": "The job details.",
"allOf": [
{
"$ref": "#/definitions/JobConfig"
}
]
},
"status": {
"description": "The current status of the job.",
"default": "__job_created__",
"allOf": [
{
"$ref": "#/definitions/JobStatus"
}
]
},
"job_log": {
"title": "Job Log",
"description": "The lob jog.",
"allOf": [
{
"$ref": "#/definitions/JobLog"
}
]
},
"submitted": {
"title": "Submitted",
"description": "When the job was submitted.",
"type": "string",
"format": "date-time"
},
"started": {
"title": "Started",
"description": "When the job was started.",
"type": "string",
"format": "date-time"
},
"finished": {
"title": "Finished",
"description": "When the job was finished.",
"type": "string",
"format": "date-time"
},
"results": {
"title": "Results",
"description": "The result(s).",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"error": {
"title": "Error",
"description": "Potential error message.",
"type": "string"
}
},
"required": [
"job_id",
"job_config",
"job_log"
],
"additionalProperties": false,
"definitions": {
"JobConfig": {
"title": "JobConfig",
"description": "A class to hold the type and configuration for a module instance.",
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
},
"inputs": {
"title": "Inputs",
"description": "A map of all the input fields and value references.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
}
},
"required": [
"module_type",
"inputs"
],
"additionalProperties": false
},
"JobStatus": {
"title": "JobStatus",
"description": "An enumeration.",
"enum": [
"__job_created__",
"__job_started__",
"__job_success__",
"__job_failed__"
]
},
"LogMessage": {
"title": "LogMessage",
"type": "object",
"properties": {
"timestamp": {
"title": "Timestamp",
"description": "The time the message was logged.",
"type": "string",
"format": "date-time"
},
"log_level": {
"title": "Log Level",
"description": "The log level.",
"type": "integer"
},
"msg": {
"title": "Msg",
"description": "The log message",
"type": "string"
}
},
"required": [
"log_level",
"msg"
]
},
"JobLog": {
"title": "JobLog",
"type": "object",
"properties": {
"log": {
"title": "Log",
"description": "The logs for this job.",
"type": "array",
"items": {
"$ref": "#/definitions/LogMessage"
}
},
"percent_finished": {
"title": "Percent Finished",
"description": "Describes how much of the job is finished. A negative number means the module does not support …
"default": -1,
"type": "integer"
}
}
}
}
}
instance.operation_details
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name OperationDetails
python_module_name kiara.models.module.operation
full_name kiara.models.module.operation.OperationDetails
metadata_schema {
"title": "OperationDetails",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"operation_id": {
"title": "Operation Id",
"description": "The id of the operation.",
"type": "string"
},
"is_internal_operation": {
"title": "Is Internal Operation",
"description": "Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists et…
"default": false,
"type": "boolean"
}
},
"required": [
"operation_id"
],
"additionalProperties": false
}
instance.operation_details.base
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name BaseOperationDetails
python_module_name kiara.models.module.operation
full_name kiara.models.module.operation.BaseOperationDetails
metadata_schema {
"title": "BaseOperationDetails",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"operation_id": {
"title": "Operation Id",
"description": "The id of the operation.",
"type": "string"
},
"is_internal_operation": {
"title": "Is Internal Operation",
"description": "Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists et…
"default": false,
"type": "boolean"
}
},
"required": [
"operation_id"
],
"additionalProperties": false
}
instance.operation_config.manifest
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ManifestOperationConfig
python_module_name kiara.models.module.operation
full_name kiara.models.module.operation.ManifestOperationConfig
metadata_schema {
"title": "ManifestOperationConfig",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"doc": {
"title": "Doc",
"description": "Documentation for this operation.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The configuration for the module.",
"type": "object"
}
},
"required": [
"doc",
"module_type"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
}
}
}
instance.operation_config.pipeline
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name PipelineOperationConfig
python_module_name kiara.models.module.operation
full_name kiara.models.module.operation.PipelineOperationConfig
metadata_schema {
"title": "PipelineOperationConfig",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"doc": {
"title": "Doc",
"description": "Documentation for this operation.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"pipeline_name": {
"title": "Pipeline Name",
"description": "The pipeline id.",
"type": "string"
},
"pipeline_config": {
"title": "Pipeline Config",
"description": "The pipeline config data.",
"type": "object"
},
"module_map": {
"title": "Module Map",
"description": "A lookup map to resolves module names to operations.",
"type": "object"
},
"metadata": {
"title": "Metadata",
"description": "Additional metadata for the pipeline.",
"type": "object"
}
},
"required": [
"doc",
"pipeline_name",
"pipeline_config"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
}
}
}
value_matcher
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name ValueMatcher
python_module_name kiara.models.values.matchers
full_name kiara.models.values.matchers.ValueMatcher
metadata_schema {
"title": "ValueMatcher",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"data_types": {
"title": "Data Types",
"description": "The data type.",
"type": "array",
"items": {
"type": "string"
}
},
"allow_sub_types": {
"title": "Allow Sub Types",
"description": "Allow subtypes.",
"default": true,
"type": "boolean"
},
"min_size": {
"title": "Min Size",
"description": "The minimum size for the dataset.",
"default": 0,
"type": "integer"
},
"max_size": {
"title": "Max Size",
"description": "The maximum size for the dataset.",
"type": "integer"
},
"allow_internal": {
"title": "Allow Internal",
"description": "Allow internal data types.",
"default": false,
"type": "boolean"
},
"has_alias": {
"title": "Has Alias",
"description": "Value must have at least one alias.",
"default": true,
"type": "boolean"
}
},
"additionalProperties": false
}
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name RenderMetadata
python_module_name kiara.models.render_value
full_name kiara.models.render_value.RenderMetadata
metadata_schema {
"title": "RenderMetadata",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"related_instructions": {
"title": "Related Instructions",
"description": "Related instructions, to be used by implementing frontends as hints.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/RenderInstruction"
}
}
},
"additionalProperties": false,
"definitions": {
"RenderInstruction": {
"title": "RenderInstruction",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
Documentation
Python class and module information.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name PythonClassMetadata
python_module_name kiara.models.values.value_metadata.included_metadata_types
full_name kiara.models.values.value_metadata.included_metadata_types.PythonClassMetadata
metadata_schema {
"title": "PythonClassMetadata",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class": {
"title": "Python Class",
"description": "Details about the Python class that backs this value.",
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
}
},
"required": [
"python_class"
],
"additionalProperties": false,
"definitions": {
"PythonClass": {
"title": "PythonClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name"
],
"additionalProperties": false
}
}
}
Documentation
File stats.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name FileMetadata
python_module_name kiara.models.values.value_metadata.included_metadata_types
full_name kiara.models.values.value_metadata.included_metadata_types.FileMetadata
metadata_schema {
"title": "FileMetadata",
"description": "File stats.",
"type": "object",
"properties": {
"file": {
"title": "File",
"description": "The file-specific metadata.",
"allOf": [
{
"$ref": "#/definitions/FileModel"
}
]
}
},
"required": [
"file"
],
"additionalProperties": false,
"definitions": {
"FileModel": {
"title": "FileModel",
"description": "Describes properties for the 'file' value type.",
"type": "object",
"properties": {
"mime_type": {
"title": "Mime Type",
"description": "The mime type of the file.",
"type": "string"
},
"file_name": {
"title": "File Name",
"default": "The name of the file.",
"type": "string"
},
"size": {
"title": "Size",
"description": "The size of the file.",
"type": "integer"
}
},
"required": [
"mime_type",
"size"
],
"additionalProperties": false
}
}
}
Documentation
File bundle stats.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name FileBundleMetadata
python_module_name kiara.models.values.value_metadata.included_metadata_types
full_name kiara.models.values.value_metadata.included_metadata_types.FileBundleMetadata
metadata_schema {
"title": "FileBundleMetadata",
"description": "File bundle stats.",
"type": "object",
"properties": {
"file_bundle": {
"title": "File Bundle",
"description": "The file-specific metadata.",
"allOf": [
{
"$ref": "#/definitions/FileBundle"
}
]
}
},
"required": [
"file_bundle"
],
"additionalProperties": false,
"definitions": {
"FileModel": {
"title": "FileModel",
"description": "Describes properties for the 'file' value type.",
"type": "object",
"properties": {
"mime_type": {
"title": "Mime Type",
"description": "The mime type of the file.",
"type": "string"
},
"file_name": {
"title": "File Name",
"default": "The name of the file.",
"type": "string"
},
"size": {
"title": "Size",
"description": "The size of the file.",
"type": "integer"
}
},
"required": [
"mime_type",
"size"
],
"additionalProperties": false
},
"FileBundle": {
"title": "FileBundle",
"description": "Describes properties for the 'file_bundle' value type.",
"type": "object",
"properties": {
"bundle_name": {
"title": "Bundle Name",
"description": "The name of this bundle.",
"type": "string"
},
"number_of_files": {
"title": "Number Of Files",
"description": "How many files are included in this bundle.",
"type": "integer"
},
"included_files": {
"title": "Included Files",
"description": "A map of all the included files, incl. their properties. Uses the relative path of each file as…
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/FileModel"
}
},
"size": {
"title": "Size",
"description": "The size of all files in this folder, combined.",
"type": "integer"
}
},
"required": [
"bundle_name",
"number_of_files",
"included_files",
"size"
],
"additionalProperties": false
}
}
}
instance.pipeline_structure
Documentation
An object that holds one or several steps, and describes the connections between them.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name PipelineStructure
python_module_name kiara.models.module.pipeline.structure
full_name kiara.models.module.pipeline.structure.PipelineStructure
metadata_schema {
"title": "PipelineStructure",
"description": "An object that holds one or several steps, and describes the connections between them.",
"type": "object",
"properties": {
"pipeline_config": {
"title": "Pipeline Config",
"description": "The underlying pipeline config.",
"allOf": [
{
"$ref": "#/definitions/PipelineConfig"
}
]
},
"steps": {
"title": "Steps",
"description": "The pipeline steps ",
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"input_aliases": {
"title": "Input Aliases",
"description": "The input aliases.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"output_aliases": {
"title": "Output Aliases",
"description": "The output aliases.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"pipeline_config",
"steps",
"input_aliases",
"output_aliases"
],
"additionalProperties": false,
"definitions": {
"StepValueAddress": {
"title": "StepValueAddress",
"description": "Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure.",
"type": "object",
"properties": {
"step_id": {
"title": "Step Id",
"description": "The id of a step within a pipeline.",
"type": "string"
},
"value_name": {
"title": "Value Name",
"description": "The name of the value (output name or pipeline input name).",
"type": "string"
},
"sub_value": {
"title": "Sub Value",
"description": "A reference to a subitem of a value (e.g. column, list item)",
"type": "object"
}
},
"required": [
"step_id",
"value_name"
],
"additionalProperties": false
},
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"KiaraModuleClass": {
"title": "KiaraModuleClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"inputs_schema": {
"title": "Inputs Schema",
"description": "The schema for the module input(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"outputs_schema": {
"title": "Outputs Schema",
"description": "The schema for the module output(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name",
"module_config",
"inputs_schema",
"outputs_schema"
],
"additionalProperties": false
},
"PipelineStep": {
"title": "PipelineStep",
"description": "A step within a pipeline-structure, includes information about it's connection(s) and other metadat…
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"step_id": {
"title": "Step Id",
"description": "Locally unique id (within a pipeline) of this step.",
"type": "string"
},
"input_links": {
"title": "Input Links",
"description": "The links that connect to inputs of the module. Keys are field names, value(s) are connected ou…
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/StepValueAddress"
}
}
},
"module_details": {
"title": "Module Details",
"description": "The class of the underlying module.",
"allOf": [
{
"$ref": "#/definitions/KiaraModuleClass"
}
]
},
"doc": {
"title": "Doc",
"description": "A description what this step does.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"module_type",
"step_id",
"module_details",
"doc"
],
"additionalProperties": false
},
"PipelineConfig": {
"title": "PipelineConfig",
"description": "A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule].\n\n…
"type": "object",
"properties": {
"constants": {
"title": "Constants",
"description": "Value constants for this module.",
"type": "object"
},
"defaults": {
"title": "Defaults",
"description": "Value defaults for this module.",
"type": "object"
},
"pipeline_name": {
"title": "Pipeline Name",
"description": "The name of this pipeline.",
"type": "string"
},
"steps": {
"title": "Steps",
"description": "A list of steps/modules of this pipeline, and their connections.",
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"input_aliases": {
"title": "Input Aliases",
"description": "A map of input aliases, with the calculated (<step_id>__<input_name> -- double underscore!) nam…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"output_aliases": {
"title": "Output Aliases",
"description": "A map of output aliases, with the calculated (<step_id>__<output_name> -- double underscore!) n…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"doc": {
"title": "Doc",
"description": "Documentation about what the pipeline does.",
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Metadata for this workflow.",
"type": "object"
}
},
"required": [
"pipeline_name",
"steps",
"input_aliases",
"output_aliases"
]
}
}
}
workflow_state
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name WorkflowState
python_module_name kiara.models.workflow
full_name kiara.models.workflow.WorkflowState
metadata_schema {
"title": "WorkflowState",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"steps": {
"title": "Steps",
"description": "The current steps in the workflow.",
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"inputs": {
"title": "Inputs",
"description": "The current (pipeline) input values.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"pipeline_info": {
"title": "Pipeline Info",
"description": "Details about the pipeline and its state.",
"allOf": [
{
"$ref": "#/definitions/PipelineInfo"
}
]
}
},
"required": [
"pipeline_info"
],
"additionalProperties": false,
"definitions": {
"StepValueAddress": {
"title": "StepValueAddress",
"description": "Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure.",
"type": "object",
"properties": {
"step_id": {
"title": "Step Id",
"description": "The id of a step within a pipeline.",
"type": "string"
},
"value_name": {
"title": "Value Name",
"description": "The name of the value (output name or pipeline input name).",
"type": "string"
},
"sub_value": {
"title": "Sub Value",
"description": "A reference to a subitem of a value (e.g. column, list item)",
"type": "object"
}
},
"required": [
"step_id",
"value_name"
],
"additionalProperties": false
},
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of…
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the value.",
"type": "string"
},
"type_config": {
"title": "Type Config",
"description": "Configuration for the type, in case it's complex.",
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), or whether 'None' value is allowed (False).",
"default": false,
"type": "boolean"
},
"is_constant": {
"title": "Is Constant",
"description": "Whether the value is a constant.",
"default": false,
"type": "boolean"
},
"doc": {
"title": "Doc",
"description": "A description for the value of this input field.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"KiaraModuleClass": {
"title": "KiaraModuleClass",
"description": "Python class and module information.",
"type": "object",
"properties": {
"python_class_name": {
"title": "Python Class Name",
"description": "The name of the Python class.",
"type": "string"
},
"python_module_name": {
"title": "Python Module Name",
"description": "The name of the Python module this class lives in.",
"type": "string"
},
"full_name": {
"title": "Full Name",
"description": "The full class namespace.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"inputs_schema": {
"title": "Inputs Schema",
"description": "The schema for the module input(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"outputs_schema": {
"title": "Outputs Schema",
"description": "The schema for the module output(s).",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
}
},
"required": [
"python_class_name",
"python_module_name",
"full_name",
"module_config",
"inputs_schema",
"outputs_schema"
],
"additionalProperties": false
},
"PipelineStep": {
"title": "PipelineStep",
"description": "A step within a pipeline-structure, includes information about it's connection(s) and other metadat…
"type": "object",
"properties": {
"module_type": {
"title": "Module Type",
"description": "The module type.",
"type": "string"
},
"module_config": {
"title": "Module Config",
"description": "The module config.",
"type": "object"
},
"step_id": {
"title": "Step Id",
"description": "Locally unique id (within a pipeline) of this step.",
"type": "string"
},
"input_links": {
"title": "Input Links",
"description": "The links that connect to inputs of the module. Keys are field names, value(s) are connected ou…
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/StepValueAddress"
}
}
},
"module_details": {
"title": "Module Details",
"description": "The class of the underlying module.",
"allOf": [
{
"$ref": "#/definitions/KiaraModuleClass"
}
]
},
"doc": {
"title": "Doc",
"description": "A description what this step does.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"module_type",
"step_id",
"module_details",
"doc"
],
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"PipelineConfig": {
"title": "PipelineConfig",
"description": "A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule].\n\n…
"type": "object",
"properties": {
"constants": {
"title": "Constants",
"description": "Value constants for this module.",
"type": "object"
},
"defaults": {
"title": "Defaults",
"description": "Value defaults for this module.",
"type": "object"
},
"pipeline_name": {
"title": "Pipeline Name",
"description": "The name of this pipeline.",
"type": "string"
},
"steps": {
"title": "Steps",
"description": "A list of steps/modules of this pipeline, and their connections.",
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"input_aliases": {
"title": "Input Aliases",
"description": "A map of input aliases, with the calculated (<step_id>__<input_name> -- double underscore!) nam…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"output_aliases": {
"title": "Output Aliases",
"description": "A map of output aliases, with the calculated (<step_id>__<output_name> -- double underscore!) n…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"doc": {
"title": "Doc",
"description": "Documentation about what the pipeline does.",
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Metadata for this workflow.",
"type": "object"
}
},
"required": [
"pipeline_name",
"steps",
"input_aliases",
"output_aliases"
]
},
"PipelineStructure": {
"title": "PipelineStructure",
"description": "An object that holds one or several steps, and describes the connections between them.",
"type": "object",
"properties": {
"pipeline_config": {
"title": "Pipeline Config",
"description": "The underlying pipeline config.",
"allOf": [
{
"$ref": "#/definitions/PipelineConfig"
}
]
},
"steps": {
"title": "Steps",
"description": "The pipeline steps ",
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"input_aliases": {
"title": "Input Aliases",
"description": "The input aliases.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"output_aliases": {
"title": "Output Aliases",
"description": "The output aliases.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"pipeline_config",
"steps",
"input_aliases",
"output_aliases"
],
"additionalProperties": false
},
"StepStatus": {
"title": "StepStatus",
"description": "Enum to describe the state of a workflow.",
"enum": [
"inputs_invalid",
"inputs_ready",
"results_ready"
]
},
"StepDetails": {
"title": "StepDetails",
"type": "object",
"properties": {
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context.",
"type": "string",
"format": "uuid"
},
"pipeline_id": {
"title": "Pipeline Id",
"description": "The id of the pipeline.",
"type": "string",
"format": "uuid"
},
"step": {
"title": "Step",
"description": "The pipeline step details.",
"allOf": [
{
"$ref": "#/definitions/PipelineStep"
}
]
},
"step_id": {
"title": "Step Id",
"description": "The id of the step.",
"type": "string"
},
"processing_stage": {
"title": "Processing Stage",
"description": "The execution stage where this step is executed.",
"type": "integer"
},
"status": {
"description": "The current status of this step.",
"allOf": [
{
"$ref": "#/definitions/StepStatus"
}
]
},
"invalid_details": {
"title": "Invalid Details",
"description": "Details about fields that are invalid (if status < 'INPUTS_READY'.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"inputs": {
"title": "Inputs",
"description": "The current inputs of this step.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"outputs": {
"title": "Outputs",
"description": "The current outputs of this step.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
}
},
"required": [
"kiara_id",
"pipeline_id",
"step",
"step_id",
"processing_stage",
"status",
"inputs",
"outputs"
]
},
"PipelineDetails": {
"title": "PipelineDetails",
"type": "object",
"properties": {
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context.",
"type": "string",
"format": "uuid"
},
"pipeline_id": {
"title": "Pipeline Id",
"description": "The id of the pipeline.",
"type": "string",
"format": "uuid"
},
"pipeline_status": {
"description": "The current status of this pipeline.",
"allOf": [
{
"$ref": "#/definitions/StepStatus"
}
]
},
"invalid_details": {
"title": "Invalid Details",
"description": "Details about fields that are invalid (if status < 'INPUTS_READY'.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"pipeline_inputs": {
"title": "Pipeline Inputs",
"description": "The current pipeline inputs.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"pipeline_outputs": {
"title": "Pipeline Outputs",
"description": "The current pipeline outputs.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"step_states": {
"title": "Step States",
"description": "The state of each step within this pipeline.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/StepDetails"
}
}
},
"required": [
"kiara_id",
"pipeline_id",
"pipeline_status",
"pipeline_inputs",
"pipeline_outputs",
"step_states"
]
},
"PipelineInfo": {
"title": "PipelineInfo",
"description": "Base class that holds/manages information about an item within kiara.",
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item type.",
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the item.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the item.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this item (description, tags, labels, references, ...).",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"pipeline_structure": {
"title": "Pipeline Structure",
"description": "The pipeline structure.",
"allOf": [
{
"$ref": "#/definitions/PipelineStructure"
}
]
},
"pipeline_details": {
"title": "Pipeline Details",
"description": "The current input details.",
"allOf": [
{
"$ref": "#/definitions/PipelineDetails"
}
]
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"pipeline_structure",
"pipeline_details"
],
"additionalProperties": false
}
}
}
instance.workflow
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name WorkflowDetails
python_module_name kiara.models.workflow
full_name kiara.models.workflow.WorkflowDetails
metadata_schema {
"title": "WorkflowDetails",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for things l…
"type": "object",
"properties": {
"workflow_id": {
"title": "Workflow Id",
"description": "The globally unique uuid for this workflow.",
"type": "string",
"format": "uuid"
},
"documentation": {
"title": "Documentation",
"description": "A description for this workflow.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "The author(s) of this workflow.",
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Workflow context details.",
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"current_state": {
"title": "Current State",
"description": "A reference to the current state of this workflow.",
"type": "string"
},
"workflow_states": {
"title": "Workflow States",
"description": "A history of all the states of this workflow.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "Short description of the item.",
"default": "-- n/a --",
"type": "string"
},
"doc": {
"title": "Doc",
"description": "Detailed documentation of the item (in markdown).",
"type": "string"
}
},
"additionalProperties": false
},
"AuthorModel": {
"title": "AuthorModel",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the author.",
"type": "string"
},
"email": {
"title": "Email",
"description": "The email address of the author",
"type": "string",
"format": "email"
}
},
"required": [
"name"
]
},
"AuthorsMetadataModel": {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"authors": {
"title": "Authors",
"description": "The authors/creators of this item.",
"type": "array",
"items": {
"$ref": "#/definitions/AuthorModel"
}
}
}
},
"LinkModel": {
"title": "LinkModel",
"type": "object",
"properties": {
"url": {
"title": "Url",
"description": "The url.",
"minLength": 1,
"maxLength": 65536,
"format": "uri",
"type": "string"
},
"desc": {
"title": "Desc",
"description": "A short description of the link content.",
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit from.\n\nThis class provides utility functions for thin…
"type": "object",
"properties": {
"references": {
"title": "References",
"description": "References for the item.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LinkModel"
}
},
"tags": {
"title": "Tags",
"description": "A list of tags for the item.",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"title": "Labels",
"description": "A list of labels for the item.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
instance.data.file
Documentation
Describes properties for the 'file' value type.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name FileModel
python_module_name kiara.models.filesystem
full_name kiara.models.filesystem.FileModel
metadata_schema {
"title": "FileModel",
"description": "Describes properties for the 'file' value type.",
"type": "object",
"properties": {
"mime_type": {
"title": "Mime Type",
"description": "The mime type of the file.",
"type": "string"
},
"file_name": {
"title": "File Name",
"default": "The name of the file.",
"type": "string"
},
"size": {
"title": "Size",
"description": "The size of the file.",
"type": "integer"
}
},
"required": [
"mime_type",
"size"
],
"additionalProperties": false
}
instance.data.file_bundle
Documentation
Describes properties for the 'file_bundle' value type.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name FileBundle
python_module_name kiara.models.filesystem
full_name kiara.models.filesystem.FileBundle
metadata_schema {
"title": "FileBundle",
"description": "Describes properties for the 'file_bundle' value type.",
"type": "object",
"properties": {
"bundle_name": {
"title": "Bundle Name",
"description": "The name of this bundle.",
"type": "string"
},
"number_of_files": {
"title": "Number Of Files",
"description": "How many files are included in this bundle.",
"type": "integer"
},
"included_files": {
"title": "Included Files",
"description": "A map of all the included files, incl. their properties. Uses the relative path of each file as key…
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/FileModel"
}
},
"size": {
"title": "Size",
"description": "The size of all files in this folder, combined.",
"type": "integer"
}
},
"required": [
"bundle_name",
"number_of_files",
"included_files",
"size"
],
"additionalProperties": false,
"definitions": {
"FileModel": {
"title": "FileModel",
"description": "Describes properties for the 'file' value type.",
"type": "object",
"properties": {
"mime_type": {
"title": "Mime Type",
"description": "The mime type of the file.",
"type": "string"
},
"file_name": {
"title": "File Name",
"default": "The name of the file.",
"type": "string"
},
"size": {
"title": "Size",
"description": "The size of the file.",
"type": "integer"
}
},
"required": [
"mime_type",
"size"
],
"additionalProperties": false
}
}
}