netdata/integrations/schemas/agent_notification.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Netdata notification mechanism metadata.",
  "oneOf": [
    {
      "$ref": "#/$defs/entry"
    },
    {
      "type": "array",
      "minLength": 1,
      "items": {
        "$ref": "#/$defs/entry"
      }
    }
  ],
  "$defs": {
    "entry": {
      "type": "object",
      "description": "Data for a single notification method.",
      "properties": {
        "id": {
          "$ref": "./shared.json#/$defs/id"
        },
        "meta": {
          "$ref": "./shared.json#/$defs/instance"
        },
        "keywords": {
          "$ref": "./shared.json#/$defs/keywords"
        },
        "overview": {
          "type": "object",
          "description": "General information about the notification method.",
          "properties": {
            "notification_description": {
              "type": "string",
              "description": "General description of what the notification method does."
            },
            "notification_limitations": {
              "type": "string",
              "description": "Explanation of any limitations of the notification method."
            }
          },
          "required": [
            "notification_description",
            "notification_limitations"
          ]
        },
        "global_setup": {
          "type": "object",
          "description": "Flags that show which global setup sections are relevant for this notification method.",
          "properties": {
            "severity_filtering": {
              "type": "boolean"
            },
            "http_proxy": {
              "type": "boolean"
            }
          },
          "required": [
            "severity_filtering",
            "http_proxy"
          ]
        },
        "setup": {
          "oneOf": [
            {
              "$ref": "./shared.json#/$defs/short_setup"
            },
            {
              "$ref": "./shared.json#/$defs/full_setup"
            }
          ]
        },
        "troubleshooting": {
          "$ref": "./shared.json#/$defs/troubleshooting"
        }
      },
      "required": [
        "id",
        "meta",
        "keywords",
        "overview",
        "setup"
      ]
    }
  }
}