cps-ncmp-events/src/main/resources/schemas/lcm/lcm-event-schema-v1.json

   1 {
   2
   3   "$schema": "https://json-schema.org/draft/2019-09/schema",
   4   "$id": "urn:cps:org.onap.ncmp.cmhandle.lcm-event:v1",
   5
   6   "$ref": "#/definitions/LcmEvent",
   7
   8   "definitions": {
   9
  10     "Values": {
  11       "description": "Values that represents the state of a cmHandle",
  12       "type": "object",
  13       "properties": {
  14         "dataSyncEnabled":{
  15           "description": "Whether data sync enabled",
  16           "type": "boolean"
  17         },
  18         "cmHandleState": {
  19           "description": "State of cmHandle",
  20           "type": "string",
  21           "enum": ["ADVISED", "READY", "LOCKED", "DELETING", "DELETED"]
  22         },
  23         "cmHandleProperties": {
  24           "description": "cmHandle properties",
  25           "type": "object",
  26           "default": null,
  27           "existingJavaType": "java.util.List<java.util.Map<String,String>>",
  28           "additionalProperties": false
  29         }
  30       },
  31       "additionalProperties": false
  32     },
  33
  34     "Event": {
  35       "description": "The Payload of an event",
  36       "type": "object",
  37       "properties": {
  38         "cmHandleId": {
  39           "description": "cmHandle id",
  40           "type": "string"
  41         },
  42         "alternateId": {
  43           "description": "alternative id for cmHandle (e.g. 3GPP FDN)",
  44           "type": "string"
  45         },
  46         "moduleSetTag": {
  47           "description": "module set tag for cmHandle",
  48           "type": "string"
  49         },
  50         "dataProducerIdentifier": {
  51           "description": "data producer identifier for cmHandle",
  52           "type": "string"
  53         },
  54         "oldValues": {
  55           "$ref": "#/definitions/Values"
  56         },
  57         "newValues": {
  58           "$ref": "#/definitions/Values"
  59         }
  60       },
  61       "required": [
  62         "cmHandleId"
  63       ],
  64       "additionalProperties": false
  65     },
  66
  67     "LcmEvent": {
  68       "description": "The payload for LCM event",
  69       "type": "object",
  70       "javaType" : "org.onap.cps.ncmp.events.lcm.v1.LcmEvent",
  71       "properties": {
  72         "eventId": {
  73           "description": "The unique id identifying the event",
  74           "type": "string"
  75         },
  76         "eventCorrelationId": {
  77           "description": "The id identifying the event",
  78           "type": "string"
  79         },
  80         "eventTime": {
  81           "description": "The timestamp when original event occurred",
  82           "type": "string"
  83         },
  84         "eventSource": {
  85           "description": "The source of the event",
  86           "type": "string"
  87         },
  88         "eventType": {
  89           "description": "The type of the event",
  90           "type": "string"
  91         },
  92         "eventSchema": {
  93           "description": "The schema that this event adheres to",
  94           "type": "string"
  95         },
  96         "eventSchemaVersion": {
  97           "description": "The version of the schema that this event adheres to",
  98           "type": "string"
  99         },
 100         "event": {
 101           "$ref": "#/definitions/Event"
 102         }
 103       },
 104       "required": [
 105         "eventId",
 106         "eventCorrelationId",
 107         "eventTime",
 108         "eventSource",
 109         "eventType",
 110         "eventSchema",
 111         "eventSchemaVersion",
 112         "event"
 113       ],
 114       "additionalProperties": false
 115     }
 116
 117   }
 118 }