segment · Schema

FunctionSetting

Properties

Name Type Description
name string The name of the setting.
label string A human-readable label for the setting.
description string A description of the setting.
type string The data type of the setting.
required boolean Whether this setting is required.
sensitive boolean Whether this setting contains sensitive data.
View JSON Schema on GitHub

JSON Schema

segment-functionsetting-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FunctionSetting",
  "title": "FunctionSetting",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the setting."
    },
    "label": {
      "type": "string",
      "description": "A human-readable label for the setting."
    },
    "description": {
      "type": "string",
      "description": "A description of the setting."
    },
    "type": {
      "type": "string",
      "description": "The data type of the setting.",
      "enum": [
        "BOOLEAN",
        "STRING",
        "TEXT_MAP"
      ]
    },
    "required": {
      "type": "boolean",
      "description": "Whether this setting is required."
    },
    "sensitive": {
      "type": "boolean",
      "description": "Whether this setting contains sensitive data."
    }
  }
}