Skip to main content
Version: v0.19.0

AlgorithmDefinitionDto

titlestringrequired

Title of the algorithm

descriptionstringrequired

Description of the algorithm

keywordsstring[]required

Keywords associated with the algorithm

imagestringrequired

Public image URL of the algorithm

imageCredentials object

Optional credentials for pulling the algorithm image

registrystringrequired

Registry hostname for pulling the algorithm image

usernamestringrequired

Username used to authenticate against the registry

passwordstringrequired

Password used to authenticate against the registry

algorithmEventsstring[]required

Algorithm event structure of the algorithm

roleDefinitionsstring[]required

Role definitions for the algorithm

internalEventsstring[]required

Internal event structure of the algorithm

uiTemplatestring[]required

UI template for visualizing internal events

AlgorithmDefinitionDto
{
"title": "string",
"description": "string",
"keywords": [
"string"
],
"image": "string",
"imageCredentials": {
"registry": "string",
"username": "string",
"password": "string"
},
"algorithmEvents": [
"string"
],
"roleDefinitions": [
"string"
],
"internalEvents": [
"string"
],
"uiTemplate": [
"string"
]
}