Skip to content

IntegerRuntimeSettingDescriptorResponse

Field Type Required Description and constraints
name RuntimeSettingName Yes
title string Yes
description string Yes
activationMode string Yes values "live", "restart"
restartRequired boolean Yes
unit string or null No
valueType "integer" Yes
current integer Yes
effective integer Yes
pending integer or null Yes
minimum integer Yes
maximum integer Yes

Additional properties are rejected by this schema.

{
"properties": {
"name": {
"$ref": "#/components/schemas/RuntimeSettingName"
},
"title": {
"type": "string",
"title": "Title"
},
"description": {
"type": "string",
"title": "Description"
},
"activationMode": {
"type": "string",
"enum": [
"live",
"restart"
],
"title": "Activationmode"
},
"restartRequired": {
"type": "boolean",
"title": "Restartrequired"
},
"unit": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Unit"
},
"valueType": {
"type": "string",
"const": "integer",
"title": "Valuetype"
},
"current": {
"type": "integer",
"title": "Current"
},
"effective": {
"type": "integer",
"title": "Effective"
},
"pending": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pending"
},
"minimum": {
"type": "integer",
"title": "Minimum"
},
"maximum": {
"type": "integer",
"title": "Maximum"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"title",
"description",
"activationMode",
"restartRequired",
"valueType",
"current",
"effective",
"pending",
"minimum",
"maximum"
],
"title": "IntegerRuntimeSettingDescriptorResponse"
}
Image preview