alarm-schema.json

   1 {
   2   "$schema": "http://json-schema.org/draft-07/schema",
   3   "$id": "https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/alarm-go.json",
   4   "type": "object",
   5   "title": "Alarm schema",
   6   "description": "Schema for RIC alarm messages.",
   7   "default": {},
   8   "examples": [
   9     {
  10       "managedObjectId": "my-pod-lib",
  11       "applicationId": "my-app",
  12       "specificProblem": 1234,
  13       "perceivedSeverity": "MAJOR",
  14       "additionalInfo": "Some App data",
  15       "identifyingInfo": "eth 0 1",
  16       "AlarmAction": "RAISE",
  17       "AlarmTime": 1591188407505707
  18     }
  19   ],
  20   "required": [
  21     "managedObjectId",
  22     "applicationId",
  23     "specificProblem",
  24     "perceivedSeverity",
  25     "identifyingInfo",
  26     "AlarmAction",
  27     "AlarmTime"
  28   ],
  29   "additionalProperties": true,
  30   "properties": {
  31     "managedObjectId": {
  32       "type": "string",
  33       "title": "The managedObjectId schema",
  34       "description": "The name of the managed object that is the cause of the fault.",
  35       "default": ""
  36     },
  37     "applicationId": {
  38       "type": "string",
  39       "title": "The applicationId schema",
  40       "description": "The name of the process that raised the alarm.",
  41       "default": ""
  42     },
  43     "specificProblem": {
  44       "type": "integer",
  45       "title": "The specificProblem schema",
  46       "description": "The problem that is the cause of the alarm.",
  47       "default": 0
  48     },
  49     "perceivedSeverity": {
  50       "type": "string",
  51       "enum": [
  52         "UNSPECIFIED",
  53         "CRITICAL",
  54         "MAJOR",
  55         "MINOR",
  56         "WARNING",
  57         "CLEARED",
  58         "DEFAULT"
  59       ],
  60       "title": "The perceivedSeverity schema",
  61       "description": "The severity of the alarm.",
  62       "default": ""
  63     },
  64     "additionalInfo": {
  65       "type": "string",
  66       "title": "The additionalInfo schema",
  67       "description": "Additional information given by the application (optional).",
  68       "default": ""
  69     },
  70     "identifyingInfo": {
  71       "type": "string",
  72       "title": "The identifyingInfo schema",
  73       "description": "Identifying additional information, which is part of alarm identity.",
  74       "default": ""
  75     },
  76     "AlarmAction": {
  77       "type": "string",
  78       "enum": [
  79         "RAISE",
  80         "CLEAR",
  81         "CLEARALL"
  82       ],
  83       "title": "The AlarmAction schema",
  84       "description": "Action to perform on the alarm.",
  85       "default": ""
  86     },
  87     "AlarmTime": {
  88       "type": "integer",
  89       "title": "The AlarmTime schema",
  90       "description": "Current system time in milliseconds since the Epoch.",
  91       "default": 0
  92     }
  93   }
  94 }