alert-schema.json

{
  "$schema": "http://json-schema.org/schema#",
  "$id": "https://smart-data-models.github.io/data-models/specs/Alert/alert-schema.json",
  "title": "Alert base schema",
  "description": "Common definitions for Alert data model",
  "definitions": {
    "Common-Alert": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Alert"
          ],
          "description": "Property. NGSI Entity type. It has to be Alert."
        },
        "description": {
          "type": "string",
          "description": "Property. Description of the Entity"
        },
        "dateIssued": {
          "type": "string",
          "format": "date-time",
          "description": "Property. Model:'https://schema.org/DateTime'. The date and time the item was issued in ISO8601 UTC format."
        },
        "validFrom": {
          "type": "string",
          "format": "date-time",
          "description": "Property. Model:'https://schema.org/DateTime'. The start of the validity period for this forecast as a ISO8601 format"
        },
        "validTo": {
          "type": "string",
          "format": "date-time",
          "description": "Property. Model:'https://schema.org/DateTime'. The end of the validity period for this forecast as a ISO8601 format"
        },
        "severity": {
          "type": "string",
          "enum": [
            "informational",
            "low",
            "medium",
            "high",
            "critical"
          ],
          "description": "Property. Severity of the Alarm"
        },
        "category": {
          "type": "string",
          "enum": [
            "traffic",
            "naturalDisaster",
            "weather",
            "environment",
            "health",
            "security",
            "agriculture"
          ],
          "description": "Property. Category of the Alert. Enum:'traffic, naturalDisaster, weather, environment, health, security, agriculture'"
        },
        "alertSource": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ],
          "description": "Relationship. Source of the alert. Model:'http://schema.org/URL'."
        },
        "data": {
          "type": "object",
          "description": "Property. Payload containing the data retrieved."
        }
      }
    }
  }
}