ric_robot_suite/xapp/schema.json

   1 {
   2   "definitions": {},
   3   "$schema": "http://json-schema.org/draft-07/schema#",
   4   "$id": "http://example.com/root.json",
   5   "type": "object",
   6   "title": "The Root Schema",
   7   "required": [
   8     "local",
   9     "logger",
  10     "rmr",
  11     "db",
  12     "controls",
  13     "metrics"
  14   ],
  15   "properties": {
  16     "local": {
  17       "$id": "#/properties/local",
  18       "type": "object",
  19       "title": "The Local Schema",
  20       "required": [
  21         "host"
  22       ],
  23       "properties": {
  24         "host": {
  25           "$id": "#/properties/local/properties/host",
  26           "type": "string",
  27           "title": "The Host Schema",
  28           "default": "",
  29           "examples": [
  30             ":8080"
  31           ],
  32           "pattern": "^(.*)$"
  33         }
  34       }
  35     },
  36     "logger": {
  37       "$id": "#/properties/logger",
  38       "type": "object",
  39       "title": "The Logger Schema",
  40       "required": [
  41         "level"
  42       ],
  43       "properties": {
  44         "level": {
  45           "$id": "#/properties/logger/properties/level",
  46           "type": "integer",
  47           "title": "The Level Schema",
  48           "default": 0,
  49           "examples": [
  50             3
  51           ]
  52         }
  53       }
  54     },
  55     "rmr": {
  56       "$id": "#/properties/rmr",
  57       "type": "object",
  58       "title": "The Rmr Schema",
  59       "required": [
  60         "protPort",
  61         "maxSize",
  62         "numWorkers",
  63         "rxMessages",
  64         "txMessages"
  65       ],
  66       "properties": {
  67         "protPort": {
  68           "$id": "#/properties/rmr/properties/protPort",
  69           "type": "string",
  70           "title": "The Protport Schema",
  71           "default": "",
  72           "examples": [
  73             "tcp:4560"
  74           ],
  75           "pattern": "^(.*)$"
  76         },
  77         "maxSize": {
  78           "$id": "#/properties/rmr/properties/maxSize",
  79           "type": "integer",
  80           "title": "The Maxsize Schema",
  81           "default": 0,
  82           "examples": [
  83             2072
  84           ]
  85         },
  86         "numWorkers": {
  87           "$id": "#/properties/rmr/properties/numWorkers",
  88           "type": "integer",
  89           "title": "The Numworkers Schema",
  90           "default": 0,
  91           "examples": [
  92             1
  93           ]
  94         },
  95         "rxMessages": {
  96           "$id": "#/properties/rmr/properties/rxMessages",
  97           "type": "array",
  98           "title": "The Rxmessages Schema",
  99           "items": {
 100             "$id": "#/properties/rmr/properties/rxMessages/items",
 101             "type": "string",
 102             "title": "The Items Schema",
 103             "default": "",
 104             "examples": [
 105               "RIC_SUB_RESP",
 106               "RIC_SUB_FAILURE",
 107               "RIC_SUB_DEL_RESP",
 108               "RIC_SUB_DEL_FAILURE",
 109               "RIC_INDICATION"
 110             ],
 111             "pattern": "^(.*)$"
 112           }
 113         },
 114         "txMessages": {
 115           "$id": "#/properties/rmr/properties/txMessages",
 116           "type": "array",
 117           "title": "The Txmessages Schema",
 118           "items": {
 119             "$id": "#/properties/rmr/properties/txMessages/items",
 120             "type": "string",
 121             "title": "The Items Schema",
 122             "default": "",
 123             "examples": [
 124               "RIC_SUB_REQ",
 125               "RIC_SUB_DEL_REQ",
 126               "RIC_SGNB_ADDITION_REQ",
 127               "RIC_SGNB_ADDITION_ACK",
 128               "RIC_SGNB_ADDITION_REJECT",
 129               "RIC_SGNB_MOD_REQUEST",
 130               "RIC_SGNB_MOD_REQUEST_ACK",
 131               "RIC_SGNB_MOD_REQUEST_REJECT",
 132               "RIC_SGNB_MOD_REQUIRED",
 133               "RIC_SGNB_MOD_CONFIRM",
 134               "RIC_SGNB_MOD_REFUSE",
 135               "RIC_SGNB_RECONF_COMPLETE",
 136               "RIC_SGNB_RELEASE_REQUEST",
 137               "RIC_SGNB_RELEASE_CONFIRM",
 138               "RIC_SGNB_RELEASE_REQUIRED",
 139               "RIC_SGNB_RELEASE_REQUEST_ACK",
 140               "RIC_SECONDARY_RAT_DATA_USAGE_REPORT",
 141               "RIC_SN_STATUS_TRANSFER",
 142               "RIC_RRC_TRANSFER",
 143               "RIC_UE_CONTEXT_RELEASE"
 144             ],
 145             "pattern": "^(.*)$"
 146           }
 147         }
 148       }
 149     },
 150     "db": {
 151       "$id": "#/properties/db",
 152       "type": "object",
 153       "title": "The Db Schema",
 154       "required": [
 155         "host",
 156         "port",
 157         "namespaces"
 158       ],
 159       "properties": {
 160         "host": {
 161           "$id": "#/properties/db/properties/host",
 162           "type": "string",
 163           "title": "The Host Schema",
 164           "default": "",
 165           "examples": [
 166             "localhost"
 167           ],
 168           "pattern": "^(.*)$"
 169         },
 170         "port": {
 171           "$id": "#/properties/db/properties/port",
 172           "type": "integer",
 173           "title": "The Port Schema",
 174           "default": 0,
 175           "examples": [
 176             6379
 177           ]
 178         },
 179         "namespaces": {
 180           "$id": "#/properties/db/properties/namespaces",
 181           "type": "array",
 182           "title": "The Namespaces Schema",
 183           "items": {
 184             "$id": "#/properties/db/properties/namespaces/items",
 185             "type": "string",
 186             "title": "The Items Schema",
 187             "default": "",
 188             "examples": [
 189               "sdl",
 190               "rnib"
 191             ],
 192             "pattern": "^(.*)$"
 193           }
 194         }
 195       }
 196     },
 197     "controls": {
 198       "$id": "#/properties/controls",
 199       "type": "object",
 200       "title": "The Controls Schema",
 201       "required": [
 202         "active",
 203         "requestorId",
 204         "ranFunctionId",
 205         "ricActionId",
 206         "interfaceId"
 207       ],
 208       "properties": {
 209         "active": {
 210           "$id": "#/properties/controls/properties/active",
 211           "type": "boolean",
 212           "title": "The Active Schema",
 213           "default": false,
 214           "examples": [
 215             true
 216           ]
 217         },
 218         "requestorId": {
 219           "$id": "#/properties/controls/properties/requestorId",
 220           "type": "integer",
 221           "title": "The Requestorid Schema",
 222           "default": 0,
 223           "examples": [
 224             66
 225           ]
 226         },
 227         "ranFunctionId": {
 228           "$id": "#/properties/controls/properties/ranFunctionId",
 229           "type": "integer",
 230           "title": "The Ranfunctionid Schema",
 231           "default": 0,
 232           "examples": [
 233             1
 234           ]
 235         },
 236         "ricActionId": {
 237           "$id": "#/properties/controls/properties/ricActionId",
 238           "type": "integer",
 239           "title": "The Ricactionid Schema",
 240           "default": 0,
 241           "examples": [
 242             0
 243           ]
 244         },
 245         "interfaceId": {
 246           "$id": "#/properties/controls/properties/interfaceId",
 247           "type": "object",
 248           "title": "The Interfaceid Schema",
 249           "required": [
 250             "globalENBId"
 251           ],
 252           "properties": {
 253             "globalENBId": {
 254               "$id": "#/properties/controls/properties/interfaceId/properties/globalENBId",
 255               "type": "object",
 256               "title": "The Globalenbid Schema",
 257               "required": [
 258                 "plmnId",
 259                 "eNBId"
 260               ],
 261               "properties": {
 262                 "plmnId": {
 263                   "$id": "#/properties/controls/properties/interfaceId/properties/globalENBId/properties/plmnId",
 264                   "type": "string",
 265                   "title": "The Plmnid Schema",
 266                   "default": "",
 267                   "examples": [
 268                     "310150"
 269                   ],
 270                   "pattern": "^(.*)$"
 271                 },
 272                 "eNBId": {
 273                   "$id": "#/properties/controls/properties/interfaceId/properties/globalENBId/properties/eNBId",
 274                   "type": "integer",
 275                   "title": "The Enbid Schema",
 276                   "default": 0,
 277                   "examples": [
 278                     202251
 279                   ]
 280                 }
 281               }
 282             }
 283           }
 284         }
 285       }
 286     },
 287     "metrics": {
 288       "$id": "#/properties/metrics",
 289       "type": "array",
 290       "title": "The Metrics Schema",
 291       "items": {
 292         "$id": "#/properties/metrics/items",
 293         "type": "object",
 294         "title": "The Items Schema",
 295         "required": [
 296           "objectName",
 297           "objectInstance",
 298           "name",
 299           "type",
 300           "description"
 301         ],
 302         "properties": {
 303           "objectName": {
 304             "$id": "#/properties/metrics/items/properties/objectName",
 305             "type": "string",
 306             "title": "The Objectname Schema",
 307             "default": "",
 308             "examples": [
 309               "UEEventStreamingCounters"
 310             ],
 311             "pattern": "^(.*)$"
 312           },
 313           "objectInstance": {
 314             "$id": "#/properties/metrics/items/properties/objectInstance",
 315             "type": "string",
 316             "title": "The Objectinstance Schema",
 317             "default": "",
 318             "examples": [
 319               "SgNBAdditionRequest"
 320             ],
 321             "pattern": "^(.*)$"
 322           },
 323           "name": {
 324             "$id": "#/properties/metrics/items/properties/name",
 325             "type": "string",
 326             "title": "The Name Schema",
 327             "default": "",
 328             "examples": [
 329               "SgNBAdditionRequest"
 330             ],
 331             "pattern": "^(.*)$"
 332           },
 333           "type": {
 334             "$id": "#/properties/metrics/items/properties/type",
 335             "type": "string",
 336             "title": "The Type Schema",
 337             "default": "",
 338             "examples": [
 339               "counter"
 340             ],
 341             "pattern": "^(.*)$"
 342           },
 343           "description": {
 344             "$id": "#/properties/metrics/items/properties/description",
 345             "type": "string",
 346             "title": "The Description Schema",
 347             "default": "",
 348             "examples": [
 349               "The total number of SG addition request events processed"
 350             ],
 351             "pattern": "^(.*)$"
 352           }
 353         }
 354       }
 355     }
 356   }
 357 }