LCM events RTD

Issue-ID: CPS-1165
Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech>
Change-Id: Ib6743bc73b260b4345a1bedf0de2ef892a6b3c87

1 files changed, 106 insertions, 0 deletions

diff --git a/docs/schemas/lcm-event-schema-v1.json b/docs/schemas/lcm-event-schema-v1.json
new file mode 100644
index 0000000000..97c0fbee22
--- /dev/null
+++ b/docs/schemas/lcm-event-schema-v1.json
@@ -0,0 +1,106 @@
+{
+
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "urn:cps:org.onap.ncmp.cmhandle.lcm-event:v1",
+
+  "$ref": "#/definitions/LcmEvent",
+
+  "definitions": {
+
+    "Values": {
+      "description": "Values that represents the state of a cmHandle",
+      "type": "object",
+      "properties": {
+        "dataSyncEnabled":{
+          "description": "Whether data sync enabled",
+          "type": "boolean"
+        },
+        "cmHandleState": {
+          "description": "State of cmHandle",
+          "type": "string",
+          "enum": ["ADVISED", "READY", "LOCKED", "DELETING", "DELETED"]
+        },
+        "cmHandleProperties": {
+          "description": "cmHandle properties",
+          "type": "object",
+          "default": null,
+          "existingJavaType": "java.util.List<java.util.Map<String,String>>",
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "Event": {
+      "description": "The Payload of an event",
+      "type": "object",
+      "properties": {
+        "cmHandleId": {
+          "description": "cmHandle id",
+          "type": "string"
+        },
+        "oldValues": {
+          "$ref": "#/definitions/Values"
+        },
+        "newValues": {
+          "$ref": "#/definitions/Values"
+        }
+      },
+      "required": [
+        "cmHandleId"
+      ],
+      "additionalProperties": false
+    },
+
+    "LcmEvent": {
+      "description": "The payload for LCM event",
+      "type": "object",
+      "javaType" : "org.onap.ncmp.cmhandle.event.lcm.LcmEvent",
+      "properties": {
+        "eventId": {
+          "description": "The unique id identifying the event",
+          "type": "string"
+        },
+        "eventCorrelationId": {
+          "description": "The id identifying the event",
+          "type": "string"
+        },
+        "eventTime": {
+          "description": "The timestamp when original event occurred",
+          "type": "string"
+        },
+        "eventSource": {
+          "description": "The source of the event",
+          "type": "string"
+        },
+        "eventType": {
+          "description": "The type of the event",
+          "type": "string"
+        },
+        "eventSchema": {
+          "description": "The schema that this event adheres to",
+          "type": "string"
+        },
+        "eventSchemaVersion": {
+          "description": "The version of the schema that this event adheres to",
+          "type": "string"
+        },
+        "event": {
+          "$ref": "#/definitions/Event"
+        }
+      },
+      "required": [
+        "eventId",
+        "eventCorrelationId",
+        "eventTime",
+        "eventSource",
+        "eventType",
+        "eventSchema",
+        "eventSchemaVersion",
+        "event"
+      ],
+      "additionalProperties": false
+    }
+
+  }
+}