schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
mta.json | name | The name of an "includes" section. This name is used by a builder to generate a parameter section in the deployment descriptor. | {"type": "string"} |
mta.json | path | A path pointing to a file that contains a map of parameters, either in JSON or in YAML format. | {"type": "string"} |
mta.json | name | An internal name which can be used for documentation purposes and shown by the deployer. | {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"} |
mta.json | type | Defines the type of action that should be executed by the deployer. | {"type": "string", "enum": ["task"]} |
mta.json | phases | A list of strings that define the points at which the hook must be executed. | {"type": "array", "items": {"type": "string", "enum": ["application.before-stop.live", "application.before-stop.idle", "application.after-stop.live", "application.after-stop.idle"]}} |
mta.json | parameters | Configuration parameters that are used when executing the hook to the target runtime environment. | {} |
mta.json | parameters-metadata | Additional information about the hook's parameters. | {} |
mta.json | requires | List of names either matching a resource name or a provided dependency name provided within the same MTA that are required by this hook. | {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"}, "parameters": {"type": "object"}, "parameters-metadata": {}}}} |
mta.json | name | An MTA internal name which must match either a provided name, or a resource name within the same MTA. | {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"} |
mta.json | parameters | Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the hook at runtime. Provided property values can be accessed by "~{<provided-property-name>}". Such expressions can be part of an arbitrary string | {"type": "object"} |
mta.json | parameters-metadata | Additional information about the hook's parameters. | {} |
mta.json | name | Defines the name of the Cloud Foundry task that should be executed. | {"type": "string"} |
mta.json | command | Defines the actual command that is executed as a Cloud Foundry task. | {"type": "string"} |
mta.json | memory | Defines the memory that is available to the Cloud Foundry task. | {} |
mta.json | disk-quota | Defines the disk space that is available to the Cloud Foundry task. | {} |
mta.json | _schema-version | The schema version that is being used for authoring a descriptor. The schema version should comply with the semantic versioning standard. | {"type": "string"} |
mta.json | ID | An application ID, that may contain any number of unicode characters and should be unique in the target runtime environment. | {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"} |
mta.json | description | A free text describing this application. | {"type": "string"} |
mta.json | version | The application version that should comply with the semantic versioning standard. | {"type": "string", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(-(0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(\\.(0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\\+[0-9a-zA-Z-]+(\\.[0-9a-zA-Z-]+)*)?$"} |
mta.json | provider | The provider or vendor of this application. | {"type": "string"} |
mta.json | copyright | A copyright statement from the provider. | {"type": "string"} |
mta.json | modules | A list of modules. | {"type": "array", "items": {"type": "object", "required": ["name", "type"], "properties": {"name": {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"}, "type": {"type": "string"}, "path": {"type": "string"}, "deployed-after": {"type": "array", "items": {"type": "string"}}, "properties": {}, "properties-metadata": {}, "parameters": {}, "parameters-metadata": {}, "hooks": {}, "build-parameters": {"type": "object"}, "includes": {"type": "array", "items": {"type": "object", "required": ["name", "path"], "properties": {"name": {"type": "string"}, "path": {"type": "string"}}}}, "provides": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"}, "public": {"type": "boolean", "default": false}, "properties": {}, "properties-metadata": {}}}}, "requires": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"}, "group": {"type": "string"}, "list": {"type": "string"}, "properties": {}, "properties-metadata": {}, "parameters": {}, "parameters-metadata": {}, "includes": {"type": "array", "items": {"type": "object", "required": ["name", "path"], "properties": {"name": {"type": "string"}, "path": {"type": "string"}}}}}}}}}} |
mta.json | name | The MTA module name which must be unique and cannot be the same as any provided property set or resource name. | {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"} |
mta.json | type | The module type that defines the design-time tools for the module. | {"type": "string"} |
mta.json | description | A free text describing this module. | {"type": "string"} |
mta.json | path | The path to a folder that contains the module artifacts. | {"type": "string"} |
mta.json | deployed-after | A list of modules that must be deployed before deploying the current module. | {"type": "array", "items": {"type": "string"}} |
mta.json | properties | A collection of key-value pairs that are available to the module at runtime. | {} |
mta.json | properties-metadata | Additional information about the module's properties. | {} |
mta.json | parameters | Configuration parameters that are used when deploying the module to the target runtime environment. | {} |
mta.json | parameters-metadata | Additional information about the module's parameters. | {} |
mta.json | hooks | A list of hooks that will be executed for the module. | {} |
mta.json | build-parameters | The build parameters define how the module is built by the corresponding tool. | {"type": "object"} |
mta.json | includes | It is possible to define parameters in external files. The "includes" section is used to point to those files. | {"type": "array", "items": {"type": "object", "required": ["name", "path"], "properties": {"name": {"type": "string"}, "path": {"type": "string"}}}} |
mta.json | name | The name of an "includes" section. This name is used by a builder to generate a parameter section in the deployment descriptor. | {"type": "string"} |
mta.json | path | A path pointing to a file that contains a map of parameters, either in JSON or in YAML format. | {"type": "string"} |
mta.json | provides | Used to define the named property sets that other modules and resources can require. | {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"}, "public": {"type": "boolean", "default": false}, "properties": {}, "properties-metadata": {}}}} |
mta.json | name | The name of the property set that the module provides. The provided name must be unique and cannot be the same as any resource or module name. | {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"} |
mta.json | public | Configures the accessibility of the provided property set; if set to "true", it is publicly accessible and can be consumed by other MTA projects. | {"type": "boolean", "default": false} |
mta.json | properties | A list of properties that are included in this property set. | {} |
mta.json | properties-metadata | Additional information about the provided set's properties. | {} |
mta.json | requires | A list of property sets provided by other modules and/or resources (providers) that this module requires. | {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"}, "group": {"type": "string"}, "list": {"type": "string"}, "properties": {}, "properties-metadata": {}, "parameters": {}, "parameters-metadata": {}, "includes": {"type": "array", "items": {"type": "object", "required": ["name", "path"], "properties": {"name": {"type": "string"}, "path": {"type": "string"}}}}}}} |
mta.json | name | The name of a provided property set or resource (provider) that this module requires. | {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"} |
mta.json | group | A "group" can be used to combine properties from multiple providers into one runtime lookup object, such as an environment variable. As of schema version 2.1, this property is DEPRECATED. | {"type": "string"} |
mta.json | list | Defines a name for a runtime lookup object, such as an environment variable, if the required property set contains multiple values; for example, if used to consume configuration data from outside this MTA project. | {"type": "string"} |
mta.json | properties | Module properties whose values are determined by the provided properties. These properties can be referenced by the tilde notation: "~{<provided-property-name>}" | {} |
mta.json | properties-metadata | Additional information about the modules's properties. | {} |
mta.json | parameters | Configuration parameters that are used when deploying the module to the target runtime environment. | {} |
mta.json | parameters-metadata | Additional information about the modules's parameters. | {} |
mta.json | includes | It is possible to define parameters in external files. The "includes" section is used to point to those files. | {"type": "array", "items": {"type": "object", "required": ["name", "path"], "properties": {"name": {"type": "string"}, "path": {"type": "string"}}}} |
mta.json | name | The name of an "includes" section. This name is used by a builder to generate a parameter section in the deployment descriptor. | {"type": "string"} |
mta.json | path | A path pointing to a file that contains a map of parameters, either in JSON or in YAML format. | {"type": "string"} |
mta.json | resources | A list of resources that are required by the modules of this MTA project. | {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"}, "type": {"type": "string"}, "properties": {}, "properties-metadata": {}, "parameters": {}, "parameters-metadata": {}, "includes": {"type": "array", "items": {"type": "object", "required": ["name", "path"], "properties": {"name": {"type": "string"}, "path": {"type": "string"}}}}, "optional": {"type": "boolean", "default": false}, "processed-after": {"type": "array", "items": {"type": "string"}}, "active": {"type": "boolean", "default": true}, "requires": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"}, "properties": {}, "properties-metadata": {}, "parameters": {}, "parameters-metadata": {}, "includes": {"type": "array", "items": {"type": "object", "required": ["name", "path"], "properties": {"name": {"type": "string"}, "path": {"type": "string"}}}}}}}}}} |
mta.json | name | The resource name which must be unique and cannot be the same as any provided property set or module name. | {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"} |
mta.json | type | A type of resource supported by deployment tools in the target environment. | {"type": "string"} |
mta.json | description | A free text describing this resource. | {"type": "string"} |
mta.json | properties | A collection of key-value pairs that can be required by modules and/or other resources as configuration data at runtime. | {} |
mta.json | properties-metadata | Additional information about the resource's properties. | {} |
mta.json | parameters | Configuration parameters that are used when provisioning the resource in the target runtime environment. | {} |
mta.json | parameters-metadata | Additional information about the resource's parameters. | {} |
mta.json | includes | It is possible to define parameters in external files. The "includes" section is used to point to those files. | {"type": "array", "items": {"type": "object", "required": ["name", "path"], "properties": {"name": {"type": "string"}, "path": {"type": "string"}}}} |
mta.json | name | The name of an "includes" section. This name is used by a builder to generate a parameter section in the deployment descriptor. | {"type": "string"} |
mta.json | path | A path pointing to a file that contains a map of parameters, either in JSON or in YAML format. | {"type": "string"} |
mta.json | optional | If the resource is set to optional and the deployment tools are unable to allocate it, then the tools will issue a warning and continue the deployment process. | {"type": "boolean", "default": false} |
mta.json | processed-after | A list containing the names of the resources that must be processed prior to this one. | {"type": "array", "items": {"type": "string"}} |
mta.json | active | If a resource is declared to be inactive, the resource will not be allocated during the deployment process. | {"type": "boolean", "default": true} |
mta.json | requires | A list of property sets provided by other modules and/or resources (providers) that this resource requires. | {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"}, "properties": {}, "properties-metadata": {}, "parameters": {}, "parameters-metadata": {}, "includes": {"type": "array", "items": {"type": "object", "required": ["name", "path"], "properties": {"name": {"type": "string"}, "path": {"type": "string"}}}}}}} |
mta.json | name | The name of a provided property set or resource (provider) that this resource requires. | {"type": "string", "pattern": "^[A-Za-z0-9_\\-\\.]+$"} |
mta.json | properties | Resource properties whose values are determined by the provided properties. These properties can be referenced by the tilde notation: "~{<provided-property-name>}" | {} |
mta.json | properties-metadata | Additional information about the required properties. | {} |
mta.json | parameters | Configuration parameters that are used when provisioning the resource in the target runtime environment. | {} |
mta.json | parameters-metadata | Additional information about the required parameters. | {} |
mta.json | includes | It is possible to define parameters in external files. The "includes" section is used to point to those files. | {"type": "array", "items": {"type": "object", "required": ["name", "path"], "properties": {"name": {"type": "string"}, "path": {"type": "string"}}}} |
mta.json | name | The name of an "includes" section. This name is used by a builder to generate a parameter section in the deployment descriptor. | {"type": "string"} |
mta.json | path | A path pointing to a file that contains a map of parameters, either in JSON or in YAML format. | {"type": "string"} |
mta.json | parameters | Global parameters that are used when building or deploying the application | {} |
mta.json | parameters-metadata | Additional information about the global parameters. | {} |
mta.json | includes | It is possible to define parameters in external files. The "includes" section is used to point to those files. | {"type": "array", "items": {"type": "object", "required": ["name", "path"], "properties": {"name": {"type": "string"}, "path": {"type": "string"}}}} |
mta.json | name | The name of an "includes" section. This name is used by a builder to generate a parameter section in the deployment descriptor. | {"type": "string"} |
mta.json | path | A path pointing to a file that contains a map of parameters, either in JSON or in YAML format. | {"type": "string"} |
jfrog-pipelines.json | JFrog-Pipelines | https://www.jfrog.com/confluence/display/JFROG/Pipelines+Developer+Guide | {"type": "object", "additionalProperties": false, "properties": {"resources": {"type": "array", "items": {}}, "pipelines": {"type": "array", "items": {}}, "template": {"type": "boolean"}, "valuesFilePath": {"type": "string"}}, "anyOf": [{"required": ["pipelines"]}, {"required": ["resources"]}]} |
jfrog-pipelines.json | Resource | https://www.jfrog.com/confluence/display/JFROG/Pipelines+Resources | {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "enum": ["Aql", "BuildInfo", "CronTrigger", "DistributionRule", "FileSpec", "GitRepo", "HelmChart", "Image", "IncomingWebhook", "OutgoingWebhook", "PropertyBag", "ReleaseBundle", "RemoteFile", "VmCluster"]}}, "allOf": [{"if": {"properties": {"type": {"enum": ["Aql"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["BuildInfo"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["CronTrigger"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["DistributionRule"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["FileSpec"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["GitRepo"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["HelmChart"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["Image"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["IncomingWebhook"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["OutgoingWebhook"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["PropertyBag"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["ReleaseBundle"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["RemoteFile"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["VmCluster"]}}}, "then": {}}]} |
jfrog-pipelines.json | Pipeline | https://www.jfrog.com/confluence/display/JFROG/Creating+Pipelines | {"type": "object", "properties": {"name": {"type": "string"}, "configuration": {"type": "object", "additionalProperties": false, "properties": {"environmentVariables": {"type": "object", "properties": {"readOnly": {"type": "object", "additionalProperties": {"type": ["string", "number", "object"], "properties": {"default": {"type": ["string", "number"]}, "values": {"type": "array", "minItems": 1, "items": {"type": ["string", "number"]}}, "allowCustom": {"type": "boolean"}}, "required": ["default"]}}}, "required": ["readOnly"]}, "nodePool": {"type": "string"}, "affinityGroup": {"type": "string"}, "jfrogCliVersion": {"type": ["string", "integer"], "enum": ["1", "2", 1, 2]}, "runtime": {"type": "object", "properties": {"type": {"type": "string", "enum": ["image", "host"]}}, "required": ["type"], "if": {"properties": {"type": {"enum": ["image"]}}}, "then": {"properties": {"type": {"enum": ["image"]}, "image": {"type": "object", "additionalProperties": false, "properties": {"auto": {"type": "object", "required": ["language", "versions"], "properties": {"language": {"type": "string"}, "versions": {"type": "array", "items": {"type": ["string", "number"]}}}}, "custom": {"type": "object", "additionalProperties": false, "required": ["name", "tag"], "properties": {"name": {"type": "string"}, "tag": {"type": "string"}, "options": {"type": "string"}, "registry": {"type": "string"}, "sourceRepository": {"type": "string"}, "region": {"type": "string"}, "autoPull": {"type": "boolean"}}}}, "oneOf": [{"required": ["auto"]}, {"required": ["custom"]}]}}, "additionalProperties": false}, "else": {"properties": {"type": {"enum": ["host"]}}, "additionalProperties": false}}, "integrations": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}}, "required": ["name"], "additionalProperties": false}}, "inputResources": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "branch": {"type": "string"}, "trigger": {"type": "boolean"}, "newVersionOnly": {"type": "boolean"}}, "required": ["name"], "additionalProperties": false}}, "outputResources": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"name": {"type": "string"}, "branch": {"type": "string"}}, "required": ["name"], "additionalProperties": false}}, "chronological": {"type": "boolean"}, "dependencyMode": {"type": "object", "properties": {"waitOnParentComplete": {"type": "boolean"}, "waitOnParentSuccess": {"type": "boolean"}, "waitOnChildComplete": {"type": "boolean"}}, "additionalProperties": false}, "retentionPolicy": {"type": "object", "properties": {"maxAgeDays": {"type": "number"}, "minRuns": {"type": "number"}}, "additionalProperties": false}}}, "steps": {"type": "array", "minItems": 1, "items": {}}}, "required": ["name", "steps"], "additionalProperties": false} |
jfrog-pipelines.json | Step | https://www.jfrog.com/confluence/display/JFROG/Pipelines+Steps | {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "enum": ["Bash", "CreateReleaseBundle", "DistributeReleaseBundle", "DockerBuild", "DockerPush", "GoBuild", "GoPublishBinary", "GoPublishModule", "GradleBuild", "HelmBlueGreenCleanup", "HelmBlueGreenDeploy", "HelmBlueGreenRoleSwitch", "HelmDeploy", "HelmPublish", "Jenkins", "Matrix", "MvnBuild", "NpmBuild", "NpmPublish", "PostMatrix", "PowerShell", "PreMatrix", "PromoteBuild", "PublishBuildInfo", "PushArtifactoryPackage", "SignReleaseBundle", "TriggerPipeline", "XrayScan"]}}, "allOf": [{"if": {"properties": {"type": {"enum": ["Bash"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["CreateReleaseBundle"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["DistributeReleaseBundle"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["DockerBuild"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["DockerPush"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["GoBuild"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["GoPublishBinary"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["GoPublishModule"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["GradleBuild"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["HelmBlueGreenCleanup"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["HelmBlueGreenDeploy"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["HelmBlueGreenRoleSwitch"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["HelmDeploy"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["HelmPublish"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["Jenkins"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["Matrix"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["PreMatrix"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["PostMatrix"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["MvnBuild"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["NpmBuild"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["NpmPublish"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["PowerShell"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["PromoteBuild"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["PublishBuildInfo"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["PushArtifactoryPackage"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["SignReleaseBundle"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["TriggerPipeline"]}}}, "then": {}}, {"if": {"properties": {"type": {"enum": ["XrayScan"]}}}, "then": {}}]} |
io-package.json | $schema | JSON schema for validation | {"type": "string"} |
io-package.json | common | Contains all common instance attributes | {"required": ["name", "version", "platform", "titleLang", "news", "desc", "mode"], "additionalProperties": false, "type": "object", "properties": {"name": {"type": "string", "pattern": "^(?![i|I][o|O][b|B][r|R][o|O][k|K][e|E][r|R])"}, "version": {"type": "string", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"}, "platform": {"type": "string", "enum": ["Javascript/Node.js"]}, "titleLang": {}, "news": {"type": "object", "minProperties": 1, "maxProperties": 20, "patternProperties": {"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$": {}}, "additionalProperties": false}, "desc": {}, "messagebox": {"type": "boolean"}, "supportedMessages": {"type": "object", "additionalProperties": false, "properties": {"custom": {"type": "boolean"}, "notifications": {"type": "boolean"}, "stopInstance": {"anyOf": [{"type": "boolean"}, {"type": "number", "multipleOf": 1, "minimum": 1000}]}, "getHistory": {"type": "boolean"}}}, "readme": {"type": "string"}, "adminUI": {"type": "object", "additionalProperties": false, "required": ["config"], "properties": {"custom": {"type": "string", "const": "json"}, "config": {"type": "string", "enum": ["html", "json", "materialize", "none"]}, "tab": {"type": "string", "enum": ["html", "materialize"]}}}, "docs": {"type": "object", "required": ["en"], "patternProperties": {"en|de|ru|pt|nl|fr|it|es|pl|uk|zh-cn": {"type": ["string", "array"], "minItems": 1, "items": {"type": "string"}}}, "additionalProperties": false}, "authors": {"type": "array", "minItems": 1, "items": {"anyOf": [{"type": "string"}, {"type": "object", "additionalProperties": false, "required": ["name"], "properties": {"name": {"type": "string"}, "email": {"type": "string"}}}]}}, "license": {"type": "string", "enum": ["LPL-1.02", "NTP", "OFL-1.1", "Bahyph", "Hippocratic-2.1", "VOSTROM", "CC-BY-3.0-AT", "CC-BY-NC-SA-2.5", "W3C-20150513", "LGPL-3.0-only", "GFDL-1.1-only", "CDL-1.0", "CC-BY-ND-2.5", "CC-BY-NC-SA-3.0-IGO", "OGC-1.0", "RPL-1.1", "GPL-2.0-or-later", "Sendmail", "LGPL-2.0-only", "OSL-3.0", "Libpng", "MS-RL", "MIT-CMU", "Linux-OpenIB", "Latex2e-translated-notice", "psutils", "Clips", "CC-BY-NC-SA-2.0-FR", "EUDatagrid", "CC-BY-ND-3.0", "w3m", "OLDAP-2.3", "AGPL-3.0-only", "AGPL-1.0-or-later", "TMate", "GFDL-1.3-invariants-only", "SchemeReport", "NAIST-2003", "BSD-4-Clause-Shortened", "PDDL-1.0", "XSkat", "CC-BY-ND-4.0", "BSD-3-Clause-LBNL", "MIT-open-group", "UnixCrypt", "LiLiQ-P-1.1", "Eurosym", "JPNIC", "NPL-1.1", "NLOD-2.0", "NPL-1.0", "CC-BY-SA-2.1-JP", "LGPLLR", "PHP-3.01", "Ruby", "CC-BY-2.0", "QPL-1.0-INRIA-2004", "Aladdin", "ODC-By-1.0", "Intel-ACPI", "LGPL-2.1-or-later", "MPL-2.0-no-copyleft-exception", "Parity-6.0.0", "Zlib", "CC-BY-SA-1.0", "CC-BY-SA-2.0-UK", "ADSL", "Net-SNMP", "YPL-1.0", "Baekmuk", "BitTorrent-1.1", "Arphic-1999", "BSD-3-Clause-No-Nuclear-Warranty", "MTLL", "JPL-image", "ZPL-2.0", "TCP-wrappers", "GPL-1.0-or-later", "PSF-2.0", "Nokia", "Entessa", "AMPAS", "TU-Berlin-1.0", "Adobe-Glyph", "DL-DE-BY-2.0", "MPL-1.0", "Dotseqn", "IBM-pibs", "Plexus", "HP-1986", "LPPL-1.1", "OLDAP-1.2", "ZPL-2.1", "LPL-1.0", "HPND-sell-variant-MIT-disclaimer", "OFFIS", "CrystalStacker", "Adobe-2006", "Zimbra-1.3", "CUA-OPL-1.0", "EUPL-1.1", "IJG", "Afmparse", "PolyForm-Noncommercial-1.0.0", "NCGL-UK-2.0", "EPL-2.0", "CC-BY-ND-1.0", "CC-BY-ND-2.0", "OFL-1.1-no-RFN", "HPND-Markus-Kuhn", "Xnet", "CNRI-Python", "Zimbra-1.4", "SGI-B-1.0", "MakeIndex", "GFDL-1.1-no-invariants-only", "TCL", "BSD-Protection", "Xdebug-1.03", "CC-BY-2.5-AU", "CECILL-C", "BSD-4.3RENO", "Brian-Gladman-3-Clause", "CC-BY-NC-SA-1.0", "OGTSL", "OLDAP-2.7", "HaskellReport", "RPL-1.5", "Unlicense", "XFree86-1.1", "CC-BY-SA-3.0", "OLDAP-2.2.2", "CC-BY-3.0-IGO", "snprintf", "CC-BY-NC-2.0", "dtoa", "MITNFA", "AML", "Artistic-2.0", "CECILL-2.0", "App-s2p", "SSH-short", "AAL", "VSL-1.0", "AFL-2.0", "OML", "CC-BY-3.0-US", "mplus", "Qhull", "FDK-AAC", "BSD-4-Clause-UC", "PolyForm-Small-Business-1.0.0", "Sleepycat", "OLDAP-2.2", "Spencer-99", "OGL-UK-1.0", "EUPL-1.2", "Linux-man-pages-copyleft-2-para", "FreeBSD-DOC", "RSCPL", "eGenix", "CC-BY-2.5", "HPND", "SCEA", "GPL-3.0-only", "Bitstream-Charter", "LAL-1.2", "APSL-1.0", "Caldera", "Xerox", "SWL", "MS-LPL", "Cube", "APSL-2.0", "APAFML", "Watcom-1.0", "SISSL", "CDDL-1.0", "CC-BY-SA-3.0-AT", "psfrag", "C-UDA-1.0", "MPL-1.1", "CC-BY-3.0-NL", "GFDL-1.2-invariants-only", "BSD-3-Clause-Attribution", "CC-BY-NC-3.0-DE", "GFDL-1.1-or-later", "NCSA", "BSD-1-Clause", "ANTLR-PD-fallback", "BSD-3-Clause-Modification", "COIL-1.0", "UPL-1.0", "CC-BY-1.0", "Leptonica", "Frameworx-1.0", "OLDAP-1.1", "FTL", "Artistic-1.0-cl8", "CC-BY-NC-ND-3.0-IGO", "CC-BY-SA-3.0-IGO", "OGL-Canada-2.0", "YPL-1.1", "CC-BY-NC-3.0", "AGPL-3.0-or-later", "SSPL-1.0", "IPL-1.0", "TPL-1.0", "Knuth-CTAN", "MIT", "Rdisc", "Abstyles", "CECILL-2.1", "libtiff", "ErlPL-1.1", "Kazlib", "RPSL-1.0", "BSD-3-Clause-Clear", "MIT-feh", "GPL-1.0-only", "MPL-2.0", "LPPL-1.3c", "CDLA-Permissive-1.0", "Xfig", "CC-PDDC", "Inner-Net-2.0", "ECL-1.0", "SMLNJ", "GFDL-1.2-only", "ECL-2.0", "Multics", "CC-BY-NC-4.0", "GFDL-1.3-no-invariants-only", "OFL-1.0-RFN", "OSL-2.1", "CC-BY-SA-2.0", "CATOSL-1.1", "ICU", "BUSL-1.1", "OPL-UK-3.0", "copyleft-next-0.3.0", "Symlinks", "Crossword", "DOC", "ISC", "Apache-2.0", "copyleft-next-0.3.1", "ASWF-Digital-Assets-1.1", "SISSL-1.2", "Unicode-TOU", "BSD-2-Clause", "CDLA-Permissive-2.0", "CC-BY-NC-SA-3.0", "HPND-export-US", "etalab-2.0", "OSET-PL-2.1", "GFDL-1.1-invariants-or-later", "OpenSSL", "ASWF-Digital-Assets-1.0", "SGI-B-2.0", "CC0-1.0", "BSD-Attribution-HPND-disclaimer", "mpich2", "Artistic-1.0", "GFDL-1.3-only", "OGDL-Taiwan-1.0", "GFDL-1.2-no-invariants-or-later", "LiLiQ-Rplus-1.1", "ImageMagick", "X11-distribute-modifications-variant", "dvipdfm", "MulanPSL-1.0", "Unicode-DFS-2015", "CC-BY-NC-1.0", "LGPL-3.0-or-later", "GD", "mpi-permissive", "OLDAP-2.6", "Minpack", "NGPL", "diffmark", "Latex2e", "OGL-UK-2.0", "AFL-2.1", "AFL-1.2", "Python-2.0.1", "CECILL-B", "OCCT-PL", "OSL-1.1", "Spencer-86", "xinetd", "GFDL-1.2-invariants-or-later", "Boehm-GC", "Graphics-Gems", "CAL-1.0-Combined-Work-Exception", "CC-BY-3.0-DE", "GLWTPL", "NIST-PD-fallback", "BSD-3-Clause", "NetCDF", "CC-BY-ND-3.0-DE", "Parity-7.0.0", "OLDAP-2.0.1", "DRL-1.0", "TU-Berlin-2.0", "Borceux", "OLDAP-1.3", "Giftware", "SGI-B-1.1", "BSD-3-Clause-No-Nuclear-License", "curl", "OLDAP-1.4", "SNIA", "W3C", "GFDL-1.3-or-later", "D-FSL-1.0", "CC-BY-NC-SA-4.0", "Naumen", "FSFAP", "BSD-3-Clause-No-Military-License", "CC-BY-SA-4.0", "xlock", "Sendmail-8.23", "MS-PL", "NIST-PD", "Community-Spec-1.0", "CERN-OHL-1.1", "GFDL-1.2-or-later", "LGPL-2.0-or-later", "Condor-1.1", "CDDL-1.1", "Glide", "OFL-1.0-no-RFN", "CMU-Mach", "ODbL-1.0", "LOOP", "Motosoto", "LGPL-2.1-only", "NASA-1.3", "EUPL-1.0", "zlib-acknowledgement", "SugarCRM-1.1.3", "Widget-Workshop", "Info-ZIP", "BSD-Advertising-Acknowledgement", "CC-BY-NC-ND-1.0", "MIT-0", "OCLC-2.0", "OSL-1.0", "Saxpath", "IJG-short", "Zend-2.0", "Cornell-Lossless-JPEG", "CECILL-1.0", "OpenPBS-2.3", "CC-BY-SA-2.5", "DSDP", "Martin-Birgmeier", "CPOL-1.02", "MIT-advertising", "IPA", "CC-BY-NC-ND-3.0-DE", "CC-BY-SA-3.0-DE", "AMDPLPA", "SimPL-2.0", "EPL-1.0", "AGPL-1.0-only", "SAX-PD", "GFDL-1.1-no-invariants-or-later", "bzip2-1.0.6", "FSFUL", "Spencer-94", "CFITSIO", "AdaCore-doc", "BSD-Source-Code", "Noweb", "SMPPL", "Linux-man-pages-copyleft-var", "Barr", "OLDAP-2.1", "TTWL", "CNRI-Python-GPL-Compatible", "OSL-2.0", "GFDL-1.3-invariants-or-later", "xpp", "W3C-19980720", "Linux-man-pages-1-para", "APL-1.0", "CPAL-1.0", "ClArtistic", "NIST-Software", "UCL-1.0", "OGL-UK-3.0", "TORQUE-1.1", "NOSL", "LiLiQ-R-1.1", "OFL-1.0", "CC-BY-NC-SA-2.0", "MIT-Wu", "RHeCos-1.1", "MIT-Festival", "HPND-sell-variant", "GPL-3.0-or-later", "TOSL", "GFDL-1.2-no-invariants-only", "BlueOak-1.0.0", "LPPL-1.2", "iMatix", "LZMA-SDK-9.11-to-9.20", "TPDL", "CC-BY-3.0", "Apache-1.0", "Fair", "EFL-2.0", "GPL-2.0-only", "CERN-OHL-P-2.0", "Wsuipa", "SPL-1.0", "BSD-3-Clause-No-Nuclear-License-2014", "MirOS", "blessing", "Jam", "OLDAP-2.4", "ANTLR-PD", "LZMA-SDK-9.22", "PHP-3.0", "OLDAP-2.2.1", "CC-BY-NC-SA-2.0-DE", "libpng-2.0", "UCAR", "gnuplot", "CC-BY-NC-2.5", "NRL", "Python-2.0", "CC-BY-NC-SA-2.0-UK", "GL2PS", "CC-BY-NC-ND-2.0", "AFL-1.1", "CC-BY-NC-ND-2.5", "MIT-enna", "CC-BY-NC-ND-4.0", "BSL-1.0", "Linux-man-pages-copyleft", "BSD-4-Clause", "QPL-1.0", "CERN-OHL-1.2", "metamail", "checkmk", "NTP-0", "Imlib2", "CC-BY-NC-ND-3.0", "APSL-1.2", "Mup", "SSH-OpenSSH", "OLFL-1.3", "BSD-3-Clause-Open-MPI", "EFL-1.0", "Intel", "Beerware", "CPL-1.0", "TermReadKey", "MulanPSL-2.0", "CNRI-Jython", "SHL-0.51", "CERN-OHL-W-2.0", "BSD-2-Clause-Patent", "SunPro", "TAPR-OHL-1.0", "CERN-OHL-S-2.0", "ZPL-1.1", "CC-BY-4.0", "BitTorrent-1.0", "libselinux-1.0", "AFL-3.0", "X11", "CC-BY-NC-SA-3.0-DE", "Bitstream-Vera", "RSA-MD", "BSD-4.3TAHOE", "EPICS", "OPL-1.0", "SHL-0.5", "FSFULLRWD", "WTFPL", "OPUBL-1.0", "LAL-1.3", "LPPL-1.3a", "NBPL-1.0", "OFL-1.1-RFN", "OLDAP-2.0", "SGP4", "GFDL-1.1-invariants-only", "CECILL-1.1", "GFDL-1.3-no-invariants-or-later", "Apache-1.1", "NLOD-1.0", "Vim", "PostgreSQL", "FSFULLR", "NLPL", "Glulxe", "libutil-David-Nugent", "Zed", "FreeImage", "0BSD", "CDLA-Sharing-1.0", "APSL-1.1", "JasPer-2.0", "HTMLTIDY", "Newsletr", "OLDAP-2.8", "LPPL-1.0", "O-UDA-1.0", "JSON", "Unicode-DFS-2016", "NICTA-1.0", "IEC-Code-Components-EULA", "Elastic-2.0", "MIT-Modern-Variant", "OLDAP-2.5", "Artistic-1.0-Perl", "CAL-1.0", "BSD-2-Clause-Views", "Interbase-1.0", "NPOSL-3.0", "gSOAP-1.3b"]}, "type": {"type": "string", "enum": ["alarm", "climate-control", "communication", "date-and-time", "energy", "metering", "garden", "general", "geoposition", "hardware", "health", "household", "infrastructure", "iot-systems", "lighting", "logic", "messaging", "misc-data", "multimedia", "network", "protocols", "storage", "utility", "vehicle", "visualization", "visualization-icons", "visualization-widgets", "weather"]}, "unsafePerm": {"type": "boolean"}, "plugins": {"type": "object"}, "adminColumns": {"type": "array", "minItems": 1, "items": {"type": "object", "required": ["name", "path", "width", "align"], "properties": {"name": {"anyOf": [{"type": "string"}, {}]}, "path": {"type": "string"}, "width": {"type": "number", "minimum": 0}, "align": {"type": "string", "enum": ["left", "right", "center", "justify"]}, "type": {"type": "string"}, "edit": {"type": "boolean"}, "objTypes": {"type": "array", "items": {"type": "string"}}}}}, "adminTab": {"type": "object", "required": ["fa-icon", "link", "name"], "additionalProperties": false, "properties": {"fa-icon": {"type": "string"}, "ignoreConfigUpdate": {"type": "boolean"}, "link": {"type": "string"}, "name": {}, "singleton": {"type": "boolean"}}}, "controller": {"type": "boolean"}, "allowInit": {"type": "boolean"}, "availableModes": {"type": "array", "minItems": 1, "items": {"type": "string", "enum": ["none", "daemon", "subscribe", "schedule", "once", "extension"]}}, "blockly": {"type": "boolean"}, "connectionType": {"type": "string", "enum": ["none", "local", "cloud"]}, "compact": {"type": "boolean"}, "dataFolder": {"type": "string"}, "dataSource": {"type": "string", "enum": ["none", "poll", "push", "assumption"]}, "dependencies": {"type": "array", "items": {"type": ["object", "string"]}}, "enabled": {"type": "boolean"}, "eraseOnUpload": {"type": "boolean", "default": true}, "extIcon": {"type": "string"}, "getHistory": {"type": "boolean"}, "globalDependencies": {"type": "array", "items": {"type": ["object", "string"]}}, "icon": {"type": "string"}, "keywords": {"type": "array", "items": {"type": "string"}}, "localLinks": {"type": "object", "patternProperties": {".+": {"anyOf": [{"type": "string"}, {"properties": {"link": {"type": "string"}, "color": {"type": "string"}, "pro": {"type": "boolean"}, "icon": {"type": "string"}}, "additionalProperties": false, "required": ["link"]}]}}}, "loglevel": {"type": "string", "enum": ["silly", "debug", "info", "warn", "error"]}, "logTransporter": {"type": "boolean"}, "main": {"type": "string"}, "materialize": {"type": "boolean"}, "materializeTab": {"type": "boolean"}, "mode": {"type": "string", "enum": ["none", "daemon", "subscribe", "schedule", "once", "extension"]}, "noConfig": {"type": "boolean"}, "noIntro": {"type": "boolean"}, "noRepository": {"type": "boolean"}, "nogit": {"type": "boolean"}, "nondeletable": {"type": "boolean"}, "onlyWWW": {"type": "boolean"}, "osDependencies": {"type": "object", "additionalProperties": false, "patternProperties": {"linux|darwin|win32": {"type": "array", "items": {"type": "string"}}}}, "os": {"anyOf": [{"type": "string", "enum": ["linux", "darwin", "win32"]}, {"type": "array", "minItems": 1, "items": {"type": "string", "enum": ["linux", "darwin", "win32"]}}]}, "preserveSettings": {"type": ["string", "array"], "items": {"type": "string"}}, "restartAdapters": {"type": "array", "items": {"type": "string"}}, "restartSchedule": {"type": "string"}, "schedule": {"type": "string"}, "serviceStates": {"type": ["boolean", "string"]}, "singletonHost": {"type": "boolean"}, "singleton": {"type": "boolean"}, "stopBeforeUpdate": {"type": "boolean"}, "stopTimeout": {"type": "number", "default": 500, "minimum": 0, "multipleOf": 1}, "subscribable": {"type": "boolean"}, "subscribe": {"type": "string"}, "supportCustoms": {"type": "boolean"}, "supportStopInstance": {"anyOf": [{"type": "boolean"}, {"type": "number", "multipleOf": 1, "minimum": 1000}]}, "visWidgets": {"minProperties": 1, "type": "object", "patternProperties": {".+": {"required": ["url", "components", "i18n"], "type": "object", "properties": {"i18n": {"anyOf": [{"const": true}, {"const": "component"}, {"type": "object", "patternProperties": {".+": {}}}]}, "url": {"type": "string"}, "components": {"type": "array", "minItems": 1, "items": {"type": "string"}}}}}}, "wakeup": {"type": "boolean"}, "webByVersion": {"type": "boolean"}, "webExtendable": {"type": "boolean"}, "webExtension": {"type": "string"}, "webPreSettings": {"type": "object"}, "webservers": {"type": "array", "items": {"type": "string"}}, "welcomeScreen": {"type": "array", "items": {"type": ["string", "object"]}}, "welcomeScreenPro": {"type": "array", "items": {"type": ["string", "object"]}}, "wwwDontUpload": {"type": "boolean"}, "tier": {"type": "number", "minimum": 1, "maximum": 3, "default": 3}, "messages": {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["title", "text", "buttons"], "properties": {"condition": {"additionalProperties": false, "type": "object", "properties": {"operand": {"enum": ["or", "and"], "default": "and"}, "rules": {"type": "array", "items": {"type": "string"}}}}, "text": {}, "link": {"type": "string"}, "level": {"enum": ["info", "warn", "error"], "default": "warn"}, "linkText": {}, "buttons": {"type": "array", "items": {"enum": ["ok", "agree", "cancel"]}}}}}, "nodeProcessParams": {"type": "array", "items": {"type": "string"}}}, "allOf": [{"if": {}, "then": {}}]} |
io-package.json | name | Name of the adapter without ioBroker | {"type": "string", "pattern": "^(?![i|I][o|O][b|B][r|R][o|O][k|K][e|E][r|R])"} |
io-package.json | version | Current adapter version | {"type": "string", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"} |
io-package.json | platform | Platform, normally Javascript/Node.js | {"type": "string", "enum": ["Javascript/Node.js"]} |
io-package.json | title | Longer name of adapter DEPRECATED: For admin version >= 5 this property is no longer required | {"type": "string"} |
io-package.json | titleLang | Longer name of adapter in all supported languages like {en: 'Adapter', de: 'adapter', ru: 'Драйвер'} | {} |
io-package.json | news | Short form of changelog in all supported languages | {"type": "object", "minProperties": 1, "maxProperties": 20, "patternProperties": {"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$": {}}, "additionalProperties": false} |
io-package.json | desc | Description, object for multilingual description | {} |
io-package.json | messagebox | true if messagebox supported. Hence, the adapter can receive sendTo messages. Up from controller v5, please use common.supportedMessages.notifications.custom = true | {"type": "boolean"} |
io-package.json | supportedMessages | Object which defines, if the adapter supports receiving messages via sendTo. Additionally, it defines if specific messages are supported. | {"type": "object", "additionalProperties": false, "properties": {"custom": {"type": "boolean"}, "notifications": {"type": "boolean"}, "stopInstance": {"anyOf": [{"type": "boolean"}, {"type": "number", "multipleOf": 1, "minimum": 1000}]}, "getHistory": {"type": "boolean"}}} |
io-package.json | custom | If custom messages are supported (same as legacy messagebox) | {"type": "boolean"} |
io-package.json | notifications | If notification handling is supported, for information, see https://github.com/foxriver76/ioBroker.notification-manager#requirements-for-messaging-adapters | {"type": "boolean"} |
io-package.json | stopInstance | If adapter supports signal stopInstance. Use number if you need more than 1000 ms for stop routine. The signal will be sent before stop to the adapter. (used if problems occurred with SIGTERM). (Same as legacy `supportStopInstance`) | {"anyOf": [{"type": "boolean"}, {"type": "number", "multipleOf": 1, "minimum": 1000}]} |
io-package.json | getHistory | If adapter supports getHistory message. (Same as legacy `getHistory`, to avoid problems, set both flags in parallel for now) | {"type": "boolean"} |
io-package.json | readme | Url of the ReadMe file | {"type": "string"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.