BooleanRuntimeSettingDescriptorResponse

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	"boolean"	Yes
current	boolean	Yes
effective	boolean	Yes
pending	boolean or null	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": "boolean",
      "title": "Valuetype"
    },
    "current": {
      "type": "boolean",
      "title": "Current"
    },
    "effective": {
      "type": "boolean",
      "title": "Effective"
    },
    "pending": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pending"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "name",
    "title",
    "description",
    "activationMode",
    "restartRequired",
    "valueType",
    "current",
    "effective",
    "pending"
  ],
  "title": "BooleanRuntimeSettingDescriptorResponse"
}

Related models

• RuntimeSettingName