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.AuthorsMe…
metadata_schema {
"title": "AuthorsMetadataModel",
"description": "Base class that all models in kiara inherit…
"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.ContextMe…
metadata_schema {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inherit…
"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 con…
"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.Documenta…
metadata_schema {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inherit…
"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 …
"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 clas…
"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 clas…
"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 inh…
"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 …
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"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 a…
"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 module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the mo…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (desc…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this m…
"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 inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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.KiaraModuleTypeI…
metadata_schema {
"title": "KiaraModuleTypeInfo",
"description": "Base class that holds/manages information a…
"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 module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the mo…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (desc…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this m…
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"process_src": {
"title": "Process Src",
"description": "The source code of the process method o…
"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 inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 a…
"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 module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the mo…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (desc…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this m…
"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 inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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.Operat…
metadata_schema {
"title": "OperationTypeInfo",
"description": "Base class that holds/manages information a…
"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 module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the mo…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (desc…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this m…
"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 inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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.DataTy…
metadata_schema {
"title": "DataTypeClassInfo",
"description": "Base class that holds/manages information a…
"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 module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the mo…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (desc…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this m…
"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…
"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 da…
"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 inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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.M…
metadata_schema {
"title": "MetadataTypeInfo",
"description": "Base class that holds/manages information a…
"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 module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the mo…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (desc…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements this m…
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"metadata_schema": {
"title": "Metadata Schema",
"description": "The (json) schema for this metadata val…
"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 inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 a…
"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 module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the mo…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (desc…
"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 th…
"type": "object"
},
"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 inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 informati…
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item t…
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for th…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements th…
"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
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.Operat…
metadata_schema {
"title": "OperationInfo",
"description": "Base class that holds/manages information a…
"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 module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for the mo…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (desc…
"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 belo…
"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 inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 inh…
"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 us…
"default": false,
"type": "boolean"
}
},
"required": [
"operation_id"
],
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"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 …
"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 configurat…
"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 t…
"allOf": [
{
"$ref": "#/definitions/OperationDetails"
}
]
},
"doc": {
"title": "Doc",
"description": "Documentation for this operation.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"module_details": {
"title": "Module Details",
"description": "The class of the underlying module.…
"allOf": [
{
"$ref": "#/definitions/KiaraModuleClass"
}
]
},
"metadata": {
"title": "Metadata",
"description": "Additional metadata for this operat…
"type": "object"
}
},
"required": [
"module_type",
"operation_id",
"operation_details",
"doc",
"module_details"
],
"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.KiaraModelClassesI…
metadata_schema {
"title": "KiaraModelClassesInfo",
"description": "Base class that all models in kiara inherit…
"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 e…
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/KiaraModelTypeInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 informati…
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item t…
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for th…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements th…
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"metadata_schema": {
"title": "Metadata Schema",
"description": "The (json) schema for this model da…
"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.ModuleTypeClasse…
metadata_schema {
"title": "ModuleTypeClassesInfo",
"description": "Base class that all models in kiara inherit…
"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": "object",
"additionalProperties": {
"$ref": "#/definitions/KiaraModuleTypeInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 informati…
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item t…
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for th…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements th…
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"process_src": {
"title": "Process Src",
"description": "The source code of the process meth…
"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.ArchiveTypeCla…
metadata_schema {
"title": "ArchiveTypeClassesInfo",
"description": "Base class that all models in kiara inherit…
"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 typ…
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ArchiveTypeInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 informati…
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item t…
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for th…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements th…
"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.Operat…
metadata_schema {
"title": "OperationTypeClassesInfo",
"description": "Base class that all models in kiara inherit…
"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 t…
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/OperationTypeInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 informati…
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item t…
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for th…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements th…
"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.DataTy…
metadata_schema {
"title": "DataTypeClassesInfo",
"description": "Base class that all models in kiara inherit…
"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 t…
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/DataTypeClassInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 informati…
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item t…
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for th…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements th…
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"value_cls": {
"title": "Value Cls",
"description": "The python class of the value itsel…
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"data_type_config_cls": {
"title": "Data Type Config Cls",
"description": "The python class holding the schema…
"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 thi…
"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.M…
metadata_schema {
"title": "MetadataTypeClassesInfo",
"description": "Base class that all models in kiara inherit…
"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 e…
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/MetadataTypeInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 informati…
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item t…
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for th…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements th…
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"metadata_schema": {
"title": "Metadata Schema",
"description": "The (json) schema for this metadata…
"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.ArchiveGroupIn…
metadata_schema {
"title": "ArchiveGroupInfo",
"description": "Base class that all models in kiara inherit…
"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 inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 informati…
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item t…
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for th…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements th…
"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
},
"ArchiveInfo": {
"title": "ArchiveInfo",
"description": "Base class that holds/manages informati…
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item t…
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for th…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (…
"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' ty…
"allOf": [
{
"$ref": "#/definitions/ArchiveTypeInfo"
}
]
},
"config": {
"title": "Config",
"description": "The configuration of this archive.",
"type": "object"
},
"details": {
"title": "Details",
"description": "Type dependent (runtime) details fo…
"type": "object"
},
"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.Operat…
metadata_schema {
"title": "OperationGroupInfo",
"description": "Base class that all models in kiara inherit…
"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 t…
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/OperationInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 inh…
"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 us…
"default": false,
"type": "boolean"
}
},
"required": [
"operation_id"
],
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"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 …
"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 configurat…
"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 t…
"allOf": [
{
"$ref": "#/definitions/OperationDetails"
}
]
},
"doc": {
"title": "Doc",
"description": "Documentation for this operation.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"module_details": {
"title": "Module Details",
"description": "The class of the underlying module.…
"allOf": [
{
"$ref": "#/definitions/KiaraModuleClass"
}
]
},
"metadata": {
"title": "Metadata",
"description": "Additional metadata for this operat…
"type": "object"
}
},
"required": [
"module_type",
"operation_id",
"operation_details",
"doc",
"module_details"
],
"additionalProperties": false
},
"OperationInfo": {
"title": "OperationInfo",
"description": "Base class that holds/manages informati…
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item t…
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for th…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (…
"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 …
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type_name",
"documentation",
"authors",
"context",
"operation",
"operation_types"
],
"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.Val…
metadata_schema {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema contai…
"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'…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (True), …
"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 inp…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataModel"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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…
"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.Pipelin…
metadata_schema {
"title": "PipelineConfig",
"description": "A class to hold the configuration for a [Pi…
"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 pipelin…
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"input_aliases": {
"title": "Input Aliases",
"description": "A map of input aliases, with the calcul…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"output_aliases": {
"title": "Output Aliases",
"description": "A map of output aliases, with the calcu…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"doc": {
"title": "Doc",
"description": "Documentation about what the pipeline d…
"default": "-- n/a --",
"type": "string"
},
"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 …
"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 …
"type": "string"
},
"sub_value": {
"title": "Sub Value",
"description": "A reference to a subitem of a value…
"type": "object"
}
},
"required": [
"step_id",
"value_name"
],
"additionalProperties": false
},
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"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 …
"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, inc…
"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 pipelin…
"type": "string"
},
"input_links": {
"title": "Input Links",
"description": "The links that connect to inputs of…
"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"
}
]
}
},
"required": [
"module_type",
"step_id",
"module_details"
],
"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.KiaraModuleConfi…
metadata_schema {
"title": "KiaraModuleConfigMetadata",
"description": "Base class that all models in kiara inherit…
"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 …
"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 …
"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.InputsM…
metadata_schema {
"title": "InputsManifest",
"description": "A class to hold the type and configuration …
"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…
"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.ValuePedig…
metadata_schema {
"title": "ValuePedigree",
"description": "A class to hold the type and configuration …
"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…
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context a value was…
"type": "string",
"format": "uuid"
},
"environments": {
"title": "Environments",
"description": "References to the runtime environment d…
"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 …
"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…
"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 …
"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…
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"job_id": {
"title": "Job Id",
"description": "The globally unique id for this job.",
"type": "string",
"format": "uuid"
},
"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"
}
]
}
},
"required": [
"module_type",
"inputs",
"job_id",
"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 fi…
"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.Pipelin…
metadata_schema {
"title": "PipelineStep",
"description": "A step within a pipeline-structure, include…
"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) o…
"type": "string"
},
"input_links": {
"title": "Input Links",
"description": "The links that connect to inputs of the…
"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"
}
]
}
},
"required": [
"module_type",
"step_id",
"module_details"
],
"additionalProperties": false,
"definitions": {
"StepValueAddress": {
"title": "StepValueAddress",
"description": "Small model to describe the address of …
"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 …
"type": "string"
},
"sub_value": {
"title": "Sub Value",
"description": "A reference to a subitem of a value…
"type": "object"
}
},
"required": [
"step_id",
"value_name"
],
"additionalProperties": false
},
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"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 …
"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.Operat…
metadata_schema {
"title": "Operation",
"description": "A class to hold the type and configuration …
"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 …
"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 inh…
"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 us…
"default": false,
"type": "boolean"
}
},
"required": [
"operation_id"
],
"additionalProperties": false
},
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"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 …
"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 potentia…
"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 field…
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ValueSchema"
}
},
"deferred_inputs": {
"title": "Deferred Inputs",
"description": "Potentially required external inputs th…
"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 inh…
"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 …
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"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 …
"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.Serializat…
metadata_schema {
"title": "SerializationMetadata",
"description": "Base class that all models in kiara inherit…
"type": "object",
"properties": {
"environment": {
"title": "Environment",
"description": "Hash(es) for the environments the value…
"type": "object",
"additionalProperties": {
"type": "integer"
}
},
"deserialize": {
"title": "Deserialize",
"description": "Suggested manifest configs to use to de…
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Manifest"
}
}
},
"additionalProperties": false,
"definitions": {
"Manifest": {
"title": "Manifest",
"description": "A class to hold the type and configurat…
"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.Serializat…
metadata_schema {
"title": "SerializationResult",
"description": "Base class that all models in kiara inherit…
"type": "object",
"properties": {
"data_type": {
"title": "Data Type",
"description": "The name of the data type for this seri…
"type": "string"
},
"data_type_config": {
"title": "Data Type Config",
"description": "The (optional) config for the data type…
"type": "object"
},
"serialization_profile": {
"title": "Serialization Profile",
"description": "An identifying name for the serializati…
"type": "string"
},
"metadata": {
"title": "Metadata",
"description": "Optional metadata describing aspects of…
"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…
"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 configurat…
"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 inh…
"type": "object",
"properties": {
"environment": {
"title": "Environment",
"description": "Hash(es) for the environments the v…
"type": "object",
"additionalProperties": {
"type": "integer"
}
},
"deserialize": {
"title": "Deserialize",
"description": "Suggested manifest configs to use t…
"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…
"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…
"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…
"type": "string"
},
"type": {
"title": "Type",
"default": "file",
"enum": [
"file"
],
"type": "string"
},
"file": {
"title": "File",
"description": "A path to a file containing the ser…
"type": "string"
}
},
"required": [
"codec",
"file"
],
"additionalProperties": false
},
"SerializedFiles": {
"title": "SerializedFiles",
"type": "object",
"properties": {
"codec": {
"title": "Codec",
"description": "The codec used to encode the chunks…
"type": "string"
},
"type": {
"title": "Type",
"default": "files",
"enum": [
"files"
],
"type": "string"
},
"files": {
"title": "Files",
"description": "A list of strings, pointing to file…
"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…
"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 extern…
}
},
"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.PersistedD…
metadata_schema {
"title": "PersistedData",
"description": "Base class that all models in kiara inherit…
"type": "object",
"properties": {
"data_type": {
"title": "Data Type",
"description": "The name of the data type for this seri…
"type": "string"
},
"data_type_config": {
"title": "Data Type Config",
"description": "The (optional) config for the data type…
"type": "object"
},
"serialization_profile": {
"title": "Serialization Profile",
"description": "An identifying name for the serializati…
"type": "string"
},
"metadata": {
"title": "Metadata",
"description": "Optional metadata describing aspects of…
"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 …
"type": "string",
"format": "uuid"
},
"chunk_id_map": {
"title": "Chunk Id Map",
"description": "Reference-ids that resolve to the value…
"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 configurat…
"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 inh…
"type": "object",
"properties": {
"environment": {
"title": "Environment",
"description": "Hash(es) for the environments the v…
"type": "object",
"additionalProperties": {
"type": "integer"
}
},
"deserialize": {
"title": "Deserialize",
"description": "Suggested manifest configs to use t…
"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 …
"type": "array",
"items": {
"type": "string"
}
},
"archive_id": {
"title": "Archive Id",
"description": "The preferred data archive to get t…
"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.ValueDetai…
metadata_schema {
"title": "ValueDetails",
"description": "A wrapper class that manages and retieves v…
"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 …
"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…
"allOf": [
{
"$ref": "#/definitions/ValuePedigree"
}
]
},
"pedigree_output_name": {
"title": "Pedigree Output Name",
"description": "The output name that produced this valu…
"type": "string"
},
"data_type_class": {
"title": "Data Type Class",
"description": "The python class that is associtated wi…
"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 inh…
"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 …
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"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 configurat…
"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 v…
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context a value…
"type": "string",
"format": "uuid"
},
"environments": {
"title": "Environments",
"description": "References to the runtime environme…
"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 …
"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 v…
"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 …
"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…
"allOf": [
{
"$ref": "#/definitions/ValuePedigree"
}
]
},
"pedigree_output_name": {
"title": "Pedigree Output Name",
"description": "The output name that produced this valu…
"type": "string"
},
"data_type_class": {
"title": "Data Type Class",
"description": "The python class that is associtated wi…
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"property_links": {
"title": "Property Links",
"description": "Links to values that are properties of …
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"destiny_backlinks": {
"title": "Destiny Backlinks",
"description": "Backlinks to values that this value act…
"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"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"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 configurat…
"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 v…
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context a value…
"type": "string",
"format": "uuid"
},
"environments": {
"title": "Environments",
"description": "References to the runtime environme…
"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 …
"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 v…
"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 …
"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…
"allOf": [
{
"$ref": "#/definitions/ValuePedigree"
}
]
},
"pedigree_output_name": {
"title": "Pedigree Output Name",
"description": "The output name that produced this valu…
"type": "string"
},
"data_type_class": {
"title": "Data Type Class",
"description": "The python class that is associtated wi…
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"property_links": {
"title": "Property Links",
"description": "Links to values that are properties of …
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"destiny_backlinks": {
"title": "Destiny Backlinks",
"description": "Backlinks to values that this value act…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"aliases": {
"title": "Aliases",
"description": "The aliases that are registered for thi…
"type": "array",
"items": {
"type": "string"
}
},
"serialized": {
"title": "Serialized",
"description": "Details for the serialization process t…
"allOf": [
{
"$ref": "#/definitions/PersistedData"
}
]
},
"destiny_links": {
"title": "Destiny Links",
"description": "References to all the values that act a…
"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"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"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 configurat…
"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 v…
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context a value…
"type": "string",
"format": "uuid"
},
"environments": {
"title": "Environments",
"description": "References to the runtime environme…
"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 …
"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 configurat…
"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 inh…
"type": "object",
"properties": {
"environment": {
"title": "Environment",
"description": "Hash(es) for the environments the v…
"type": "object",
"additionalProperties": {
"type": "integer"
}
},
"deserialize": {
"title": "Deserialize",
"description": "Suggested manifest configs to use t…
"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 …
"type": "array",
"items": {
"type": "string"
}
},
"archive_id": {
"title": "Archive Id",
"description": "The preferred data archive to get t…
"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 inh…
"type": "object",
"properties": {
"data_type": {
"title": "Data Type",
"description": "The name of the data type for this …
"type": "string"
},
"data_type_config": {
"title": "Data Type Config",
"description": "The (optional) config for the data …
"type": "object"
},
"serialization_profile": {
"title": "Serialization Profile",
"description": "An identifying name for the seriali…
"type": "string"
},
"metadata": {
"title": "Metadata",
"description": "Optional metadata describing aspect…
"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 …
"type": "string",
"format": "uuid"
},
"chunk_id_map": {
"title": "Chunk Id Map",
"description": "Reference-ids that resolve to the v…
"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.Unloadable…
metadata_schema {
"title": "UnloadableData",
"description": "A special 'marker' model, indicating that t…
"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 inh…
"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 …
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"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 configurat…
"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 v…
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context a value…
"type": "string",
"format": "uuid"
},
"environments": {
"title": "Environments",
"description": "References to the runtime environme…
"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 …
"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 retiev…
"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 va…
"type": "string",
"format": "uuid"
},
"value_schema": {
"title": "Value Schema",
"description": "The schema that was used for this V…
"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 in…
"allOf": [
{
"$ref": "#/definitions/ValuePedigree"
}
]
},
"pedigree_output_name": {
"title": "Pedigree Output Name",
"description": "The output name that produced this …
"type": "string"
},
"data_type_class": {
"title": "Data Type Class",
"description": "The python class that is associtate…
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"property_links": {
"title": "Property Links",
"description": "Links to values that are properties…
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"destiny_backlinks": {
"title": "Destiny Backlinks",
"description": "Backlinks to values that this value…
"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"
],
"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.ValueMapRe…
metadata_schema {
"title": "ValueMapReadOnly",
"description": "Base class that all models in kiara inherit…
"type": "object",
"properties": {
"values_schema": {
"title": "Values Schema",
"description": "The schemas for all the values in this …
"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 inh…
"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 …
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"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 configurat…
"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 v…
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context a value…
"type": "string",
"format": "uuid"
},
"environments": {
"title": "Environments",
"description": "References to the runtime environme…
"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 …
"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 retiev…
"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 va…
"type": "string",
"format": "uuid"
},
"value_schema": {
"title": "Value Schema",
"description": "The schema that was used for this V…
"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 in…
"allOf": [
{
"$ref": "#/definitions/ValuePedigree"
}
]
},
"pedigree_output_name": {
"title": "Pedigree Output Name",
"description": "The output name that produced this …
"type": "string"
},
"data_type_class": {
"title": "Data Type Class",
"description": "The python class that is associtate…
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"property_links": {
"title": "Property Links",
"description": "Links to values that are properties…
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"destiny_backlinks": {
"title": "Destiny Backlinks",
"description": "Backlinks to values that this value…
"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"
],
"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.ValueMapWr…
metadata_schema {
"title": "ValueMapWritable",
"description": "Base class that all models in kiara inherit…
"type": "object",
"properties": {
"values_schema": {
"title": "Values Schema",
"description": "The schemas for all the values in this …
"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 resul…
"allOf": [
{
"$ref": "#/definitions/ValuePedigree"
}
]
}
},
"required": [
"values_schema",
"pedigree"
],
"additionalProperties": false,
"definitions": {
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"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 configurat…
"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 v…
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"kiara_id": {
"title": "Kiara Id",
"description": "The id of the kiara context a value…
"type": "string",
"format": "uuid"
},
"environments": {
"title": "Environments",
"description": "References to the runtime environme…
"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 …
"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 retiev…
"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 va…
"type": "string",
"format": "uuid"
},
"value_schema": {
"title": "Value Schema",
"description": "The schema that was used for this V…
"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 in…
"allOf": [
{
"$ref": "#/definitions/ValuePedigree"
}
]
},
"pedigree_output_name": {
"title": "Pedigree Output Name",
"description": "The output name that produced this …
"type": "string"
},
"data_type_class": {
"title": "Data Type Class",
"description": "The python class that is associtate…
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"property_links": {
"title": "Property Links",
"description": "Links to values that are properties…
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uuid"
}
},
"destiny_backlinks": {
"title": "Destiny Backlinks",
"description": "Backlinks to values that this value…
"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"
],
"additionalProperties": false
}
}
}
instance.value_map.aliases
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 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 inh…
"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 …
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"AliasValueMap": {
"title": "AliasValueMap",
"description": "Base class that all models in kiara inh…
"type": "object",
"properties": {
"values_schema": {
"title": "Values Schema",
"description": "The schemas for all the values in t…
"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 ma…
"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…
"allOf": [
{
"$ref": "#/definitions/ValueSchema"
}
]
},
"assoc_value": {
"title": "Assoc Value",
"description": "The value that is associated with t…
"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.kia…
full_name kiara.models.runtime_environment.kia…
metadata_schema {
"title": "KiaraTypesRuntimeEnvironment",
"description": "Base class that all models in kiara inherit…
"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 inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 informati…
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item t…
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for th…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements th…
"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 inh…
"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": "object",
"additionalProperties": {
"$ref": "#/definitions/ArchiveTypeInfo"
}
}
},
"required": [
"item_infos"
],
"additionalProperties": false
},
"MetadataTypeInfo": {
"title": "MetadataTypeInfo",
"description": "Base class that holds/manages informati…
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item t…
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for th…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements th…
"allOf": [
{
"$ref": "#/definitions/PythonClass"
}
]
},
"metadata_schema": {
"title": "Metadata Schema",
"description": "The (json) schema for this metadata…
"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 inh…
"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 f…
"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.ope…
full_name kiara.models.runtime_environment.ope…
metadata_schema {
"title": "OSRuntimeEnvironment",
"description": "Manages information about the OS this kiara…
"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.pyt…
full_name kiara.models.runtime_environment.pyt…
metadata_schema {
"title": "PythonRuntimeEnvironment",
"description": "Base class that all models in kiara inherit…
"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 (v…
"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"
]
}
}
}
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…
"type": "object",
"properties": {
"kiara_id": {
"title": "Kiara Id",
"description": "The (globally unique) id of the kiara c…
"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 co…
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"aliases": {
"title": "Aliases",
"description": "All available aliases within this conte…
"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 inh…
"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 …
"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 inh…
"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 con…
"default": "-- n/a --",
"type": "string"
}
},
"required": [
"url"
]
},
"ContextMetadataModel": {
"title": "ContextMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"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 informati…
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item t…
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for th…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (…
"allOf": [
{
"$ref": "#/definitions/ContextMetadataModel"
}
]
},
"python_class": {
"title": "Python Class",
"description": "The python class that implements th…
"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
},
"ArchiveInfo": {
"title": "ArchiveInfo",
"description": "Base class that holds/manages informati…
"type": "object",
"properties": {
"type_name": {
"title": "Type Name",
"description": "The registered name for this item t…
"type": "string"
},
"documentation": {
"title": "Documentation",
"description": "Documentation for the module.",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
},
"authors": {
"title": "Authors",
"description": "Information about authorship for th…
"allOf": [
{
"$ref": "#/definitions/AuthorsMetadataModel"
}
]
},
"context": {
"title": "Context",
"description": "Generic properties of this module (…
"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' ty…
"allOf": [
{
"$ref": "#/definitions/ArchiveTypeInfo"
}
]
},
"config": {
"title": "Config",
"description": "The configuration of this archive.",
"type": "object"
},
"details": {
"title": "Details",
"description": "Type dependent (runtime) details fo…
"type": "object"
},
"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 inh…
"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.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…
"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 configurat…
"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 v…
"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 fi…
"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.Operat…
metadata_schema {
"title": "OperationDetails",
"description": "Base class that all models in kiara inherit…
"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 k…
"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.BaseOp…
metadata_schema {
"title": "BaseOperationDetails",
"description": "Base class that all models in kiara inherit…
"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 k…
"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.Manife…
metadata_schema {
"title": "ManifestOperationConfig",
"description": "Base class that all models in kiara inherit…
"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 inh…
"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 …
"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.Pipeli…
metadata_schema {
"title": "PipelineOperationConfig",
"description": "Base class that all models in kiara inherit…
"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 t…
"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 inh…
"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 …
"type": "string"
}
},
"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.RenderMeta…
metadata_schema {
"title": "RenderMetadata",
"description": "Base class that all models in kiara inherit…
"type": "object",
"properties": {
"related_instructions": {
"title": "Related Instructions",
"description": "Related instructions, to be used by imp…
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/RenderInstruction"
}
}
},
"additionalProperties": false,
"definitions": {
"RenderInstruction": {
"title": "RenderInstruction",
"description": "Base class that all models in kiara inh…
"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.i…
full_name kiara.models.values.value_metadata.i…
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 bac…
"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 …
"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.i…
full_name kiara.models.values.value_metadata.i…
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' val…
"type": "object",
"properties": {
"import_time": {
"title": "Import Time",
"description": "The time when the file was imported…
"type": "string",
"format": "date-time"
},
"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": [
"import_time",
"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.i…
full_name kiara.models.values.value_metadata.i…
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' val…
"type": "object",
"properties": {
"import_time": {
"title": "Import Time",
"description": "The time when the file was imported…
"type": "string",
"format": "date-time"
},
"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": [
"import_time",
"mime_type",
"size"
],
"additionalProperties": false
},
"FileBundle": {
"title": "FileBundle",
"description": "Describes properties for the 'file_bund…
"type": "object",
"properties": {
"bundle_name": {
"title": "Bundle Name",
"description": "The name of this bundle.",
"type": "string"
},
"import_time": {
"title": "Import Time",
"description": "The time when the file bundle was i…
"type": "string",
"format": "date-time"
},
"number_of_files": {
"title": "Number Of Files",
"description": "How many files are included in this…
"type": "integer"
},
"included_files": {
"title": "Included Files",
"description": "A map of all the included files, in…
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/FileModel"
}
},
"size": {
"title": "Size",
"description": "The size of all files in this folde…
"type": "integer"
}
},
"required": [
"bundle_name",
"import_time",
"number_of_files",
"included_files",
"size"
],
"additionalProperties": false
}
}
}
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 t…
"type": "object",
"properties": {
"import_time": {
"title": "Import Time",
"description": "The time when the file was imported.",
"type": "string",
"format": "date-time"
},
"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": [
"import_time",
"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' …
"type": "object",
"properties": {
"bundle_name": {
"title": "Bundle Name",
"description": "The name of this bundle.",
"type": "string"
},
"import_time": {
"title": "Import Time",
"description": "The time when the file bundle was impor…
"type": "string",
"format": "date-time"
},
"number_of_files": {
"title": "Number Of Files",
"description": "How many files are included in this bun…
"type": "integer"
},
"included_files": {
"title": "Included Files",
"description": "A map of all the included files, incl. …
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/FileModel"
}
},
"size": {
"title": "Size",
"description": "The size of all files in this folder, c…
"type": "integer"
}
},
"required": [
"bundle_name",
"import_time",
"number_of_files",
"included_files",
"size"
],
"additionalProperties": false,
"definitions": {
"FileModel": {
"title": "FileModel",
"description": "Describes properties for the 'file' val…
"type": "object",
"properties": {
"import_time": {
"title": "Import Time",
"description": "The time when the file was imported…
"type": "string",
"format": "date-time"
},
"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": [
"import_time",
"mime_type",
"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.structu…
full_name kiara.models.module.pipeline.structu…
metadata_schema {
"title": "PipelineStructure",
"description": "An object that holds one or several steps, …
"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 …
"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 …
"type": "string"
},
"sub_value": {
"title": "Sub Value",
"description": "A reference to a subitem of a value…
"type": "object"
}
},
"required": [
"step_id",
"value_name"
],
"additionalProperties": false
},
"DocumentationMetadataModel": {
"title": "DocumentationMetadataModel",
"description": "Base class that all models in kiara inh…
"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 …
"type": "string"
}
},
"additionalProperties": false
},
"ValueSchema": {
"title": "ValueSchema",
"description": "The schema of a value.\n\nThe schema co…
"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…
"type": "object"
},
"default": {
"title": "Default",
"description": "A default value.",
"default": "__not_set__"
},
"optional": {
"title": "Optional",
"description": "Whether this value is required (Tru…
"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…
"default": "-- n/a --",
"allOf": [
{
"$ref": "#/definitions/DocumentationMetadataMod…
}
]
}
},
"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 …
"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, inc…
"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 pipelin…
"type": "string"
},
"input_links": {
"title": "Input Links",
"description": "The links that connect to inputs of…
"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"
}
]
}
},
"required": [
"module_type",
"step_id",
"module_details"
],
"additionalProperties": false
},
"PipelineConfig": {
"title": "PipelineConfig",
"description": "A class to hold the configuration for a…
"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 pip…
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStep"
}
},
"input_aliases": {
"title": "Input Aliases",
"description": "A map of input aliases, with the ca…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"output_aliases": {
"title": "Output Aliases",
"description": "A map of output aliases, with the c…
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"doc": {
"title": "Doc",
"description": "Documentation about what the pipeli…
"default": "-- n/a --",
"type": "string"
},
"context": {
"title": "Context",
"description": "Metadata for this workflow.",
"type": "object"
}
},
"required": [
"pipeline_name",
"steps",
"input_aliases",
"output_aliases"
]
}
}
}