NumberRuntimeSettingDescriptorResponse

Fields

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	"number"	Yes
current	number	Yes
effective	number	Yes
pending	number or null	Yes
minimum	number	Yes
maximum	number	Yes

Additional properties are rejected by this schema.

JSON 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": "number",
      "title": "Valuetype"
    },
    "current": {
      "type": "number",
      "title": "Current"
    },
    "effective": {
      "type": "number",
      "title": "Effective"
    },
    "pending": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pending"
    },
    "minimum": {
      "type": "number",
      "title": "Minimum"
    },
    "maximum": {
      "type": "number",
      "title": "Maximum"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "name",
    "title",
    "description",
    "activationMode",
    "restartRequired",
    "valueType",
    "current",
    "effective",
    "pending",
    "minimum",
    "maximum"
  ],
  "title": "NumberRuntimeSettingDescriptorResponse"
}

Related models

• RuntimeSettingName