Keboola · Schema

SettingResult

One setting key-value pair.

Data PlatformETLELTData PipelinesData StorageTransformationsOrchestrationData OperationsCloud DataSnowflakeBigQuery

Properties

Name	Type	Description
defaultValue	object	Default value.
description	string	Key description.
key	string	Key path.
overwritten	boolean	True, if the default value is locally overwritten.
protected	boolean	True, if only a super admin can modify the key.
type	string	Value type.
validation	string	Validation rules as a string definition.
value	object	Actual value.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SettingResult",
  "type": "object",
  "properties": {
    "defaultValue": {
      "description": "Default value.",
      "example": "30s"
    },
    "description": {
      "type": "string",
      "description": "Key description.",
      "example": "Minimal interval between uploads."
    },
    "key": {
      "type": "string",
      "description": "Key path.",
      "example": "some.service.limit"
    },
    "overwritten": {
      "type": "boolean",
      "description": "True, if the default value is locally overwritten.",
      "example": true
    },
    "protected": {
      "type": "boolean",
      "description": "True, if only a super admin can modify the key.",
      "example": false
    },
    "type": {
      "type": "string",
      "description": "Value type.",
      "example": "string",
      "enum": [
        "string",
        "int",
        "float",
        "bool",
        "[]string",
        "[]int",
        "[]float"
      ]
    },
    "validation": {
      "type": "string",
      "description": "Validation rules as a string definition.",
      "example": "minDuration=15s"
    },
    "value": {
      "description": "Actual value.",
      "example": "1m20s"
    }
  },
  "description": "One setting key-value pair.",
  "example": {
    "key": "some.service.limit",
    "type": "string",
    "description": "Minimal interval between uploads.",
    "value": "1m20s",
    "defaultValue": "30s",
    "overwritten": true,
    "protected": false,
    "validation": "minDuration=15s"
  },
  "required": [
    "key",
    "type",
    "description",
    "value",
    "defaultValue",
    "overwritten",
    "protected"
  ]
}