RTD update related to event schemas

- moving the event schemas file to corresponding folder in the docs
  folder as it is in the cps-ncmp-events
- the files are updated as per the new event data schemas

Issue-ID: CPS-2645
Change-Id: Ibcc9b504c6db8a3556773eeaadebcf02f1a3bb96
Signed-off-by: mpriyank <priyank.maheshwari@est.tech>

diff --git a/cps-ncmp-events/src/main/resources/schemas/ncmp/avc/ncmp-out-event-schema-1.0.0.json b/cps-ncmp-events/src/main/resources/schemas/ncmp/avc/ncmp-out-event-schema-1.0.0.json
index 466ce04..f1dabc1 100644 (file)
--- a/cps-ncmp-events/src/main/resources/schemas/ncmp/avc/ncmp-out-event-schema-1.0.0.json
+++ b/cps-ncmp-events/src/main/resources/schemas/ncmp/avc/ncmp-out-event-schema-1.0.0.json
@@ -30,17 +30,17 @@
         "acceptedTargets": {
           "type": "object",
           "existingJavaType": "java.util.Collection<String>",
-          "description": "Unique Collection of accepted targets"
+          "description": "Collection of accepted targets"
         },
         "rejectedTargets": {
           "type": "object",
           "existingJavaType": "java.util.Collection<String>",
-          "description": "Unique Collection of rejected targets"
+          "description": "Collection of rejected targets"
         },
         "pendingTargets": {
           "type": "object",
           "existingJavaType": "java.util.Collection<String>",
-          "description": "Unique Collection of pending targets"
+          "description": "Collection of pending targets"
         }
       },
       "required": [

diff --git a/docs/cm-handle-lcm-events.rst b/docs/cm-handle-lcm-events.rst
index 38339e2..3663ffa 100644 (file)
--- a/docs/cm-handle-lcm-events.rst
+++ b/docs/cm-handle-lcm-events.rst
@@ -27,7 +27,8 @@ CM Handle  LCM Event Schema
 ---------------------------
 The current published LCM event is based on the following schema:
 
-:download:`Life cycle management event schema <schemas/lcm-event-schema-v1.json>`
+:download:`Life cycle management event header <schemas/lcm/lcm-event-header-v1.json>`
+:download:`Life cycle management event schema <schemas/lcm/lcm-event-schema-v1.json>`
 
 CM Handle LCM Event structure
 -----------------------------

diff --git a/docs/cm-notification-subscriptions.rst b/docs/cm-notification-subscriptions.rst
index e1d1c2f..0643b8e 100644 (file)
--- a/docs/cm-notification-subscriptions.rst
+++ b/docs/cm-notification-subscriptions.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2024 Nordix Foundation
+.. Copyright (C) 2024-2025 Nordix Foundation
 
 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
 .. _cmNotificationSubscriptions:
@@ -21,11 +21,11 @@ The CM Subscription flow is event driven and adheres to the CNCF Cloud Events Sp
 
 Event to create and delete a subscription.
 
-:download:`CM Subscription Event Schema <schemas/ncmp-in-event-schema-1.0.0.json>`
+:download:`CM Subscription Event Schema <schemas/ncmp/avc/ncmp-in-event-schema-1.0.0.json>`
 
 Event to receive status of participants in a subscription.
 
-:download:`CM Subscription Response Event Schema <schemas/ncmp-out-event-schema-1.0.0.json>`
+:download:`CM Subscription Response Event Schema <schemas/ncmp/avc/ncmp-out-event-schema-1.0.0.json>`
 
 CM Subscriptions Creation
 -------------------------
@@ -52,7 +52,7 @@ CM Notifications are triggered by any change in the network, provided the client
 
 The CM Notification Event follows the structure outlined in the schema below:
 
-:download:`CM Data Notification Event Schema <schemas/dmidataavc/avc-event-schema-1.0.0.json>`
+:download:`CM Data Notification Event Schema <schemas/dmi/cm-events/avc-event-schema-1.0.0.json>`
 
 **Note.** NCMP uses the CM Notification event key from the source topic to forward notifications to the client, ensuring that the order of notifications within a topic partition is maintained during forwarding.
 **Note.** If the notification key from the source topic is null, NCMP cannot guarantee the order of events within a topic partition when forwarding.

diff --git a/docs/data-operation-events.rst b/docs/data-operation-events.rst
index 51ec125..4e2be44 100644 (file)
--- a/docs/data-operation-events.rst
+++ b/docs/data-operation-events.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2023 Nordix Foundation
+.. Copyright (C) 2023-2025 Nordix Foundation
 
 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
 .. _dataOperationEvents:
@@ -15,7 +15,7 @@ Please refer to the `cloud events <https://cloudevents.io/>`_ for more details.
 Data operation response events
 ******************************
 
-:download:`Data operation event schema <schemas/data-operation-event-schema-1.0.0.json>`
+:download:`Data operation event schema <schemas/ncmp/async-m2m/data-operation-event-schema-1.0.0.json>`
 
 Event headers example
 ^^^^^^^^^^^^^^^^^^^^^

diff --git a/docs/ncmp-async-events.rst b/docs/ncmp-async-events.rst
index 49bf570..4b12845 100644 (file)
--- a/docs/ncmp-async-events.rst
+++ b/docs/ncmp-async-events.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2023 Nordix Foundation
+.. Copyright (C) 2023-2025 Nordix Foundation
 
 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
 .. _asyncEvents:
@@ -17,7 +17,7 @@ Introduction
 
 Async events are triggered when a valid topic has been detected in a passthrough operation.
 
-:download:`NCMP request response event schema <schemas/ncmp-async-request-response-event-schema-v1.json>`
+:download:`NCMP request response event schema <schemas/ncmp/async-m2m/ncmp-async-request-response-event-schema-v1.json>`
 
 Event header
 ^^^^^^^^^^^^

diff --git a/docs/ncmp-data-operation.rst b/docs/ncmp-data-operation.rst
index 229ef3a..6999a58 100644 (file)
--- a/docs/ncmp-data-operation.rst
+++ b/docs/ncmp-data-operation.rst
@@ -152,4 +152,4 @@ DMI Service 2 (POST) : `http://{dmi-host-name}:{dmi-port}/dmi/v1/data?topic=my-t
 
 Above examples are for illustration purposes only. Please refer to link below for latest schema.
 
-:download:`Data operation event schema <schemas/data-operation-event-schema-1.0.0.json>`
+:download:`Data operation event schema <schemas/ncmp/async-m2m/data-operation-event-schema-1.0.0.json>`

diff --git a/docs/schemas/dmidataavc/avc-event-schema-1.0.0.json b/docs/schemas/dmi/cm-events/avc-event-schema-1.0.0.json
similarity index 100%
rename from docs/schemas/dmidataavc/avc-event-schema-1.0.0.json
rename to docs/schemas/dmi/cm-events/avc-event-schema-1.0.0.json

diff --git a/docs/schemas/lcm/lcm-event-header-v1.json b/docs/schemas/lcm/lcm-event-header-v1.json
new file mode 100644 (file)
index 0000000..8c9922e
--- /dev/null
+++ b/docs/schemas/lcm/lcm-event-header-v1.json
@@ -0,0 +1,56 @@
+{
+
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "urn:cps:org.onap.ncmp.cmhandle.lcm-event-header:v1",
+  "$ref": "#/definitions/LcmEventHeader",
+
+  "definitions": {
+    "LcmEventHeader": {
+      "description": "The header for LCM event",
+      "type": "object",
+      "javaType" : "org.onap.cps.ncmp.events.lcm.v1.LcmEventHeader",
+      "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"
+        }
+      },
+      "required": [
+        "eventId",
+        "eventCorrelationId",
+        "eventTime",
+        "eventSource",
+        "eventType",
+        "eventSchema",
+        "eventSchemaVersion",
+        "event"
+      ],
+      "additionalProperties": false
+    }
+
+  }
+}

diff --git a/docs/schemas/lcm-event-schema-v1.json b/docs/schemas/lcm/lcm-event-schema-v1.json
similarity index 85%
rename from docs/schemas/lcm-event-schema-v1.json
rename to docs/schemas/lcm/lcm-event-schema-v1.json
index 97c0fbe..bd0d90d 100644 (file)
--- a/docs/schemas/lcm-event-schema-v1.json
+++ b/docs/schemas/lcm/lcm-event-schema-v1.json
@@ -39,6 +39,18 @@
           "description": "cmHandle id",
           "type": "string"
         },
+        "alternateId": {
+          "description": "alternative id for cmHandle (e.g. 3GPP FDN)",
+          "type": "string"
+        },
+        "moduleSetTag": {
+          "description": "module set tag for cmHandle",
+          "type": "string"
+        },
+        "dataProducerIdentifier": {
+          "description": "data producer identifier for cmHandle",
+          "type": "string"
+        },
         "oldValues": {
           "$ref": "#/definitions/Values"
         },
@@ -55,7 +67,7 @@
     "LcmEvent": {
       "description": "The payload for LCM event",
       "type": "object",
-      "javaType" : "org.onap.ncmp.cmhandle.event.lcm.LcmEvent",
+      "javaType" : "org.onap.cps.ncmp.events.lcm.v1.LcmEvent",
       "properties": {
         "eventId": {
           "description": "The unique id identifying the event",

diff --git a/docs/schemas/data-operation-event-schema-1.0.0.json b/docs/schemas/ncmp/async-m2m/data-operation-event-schema-1.0.0.json
similarity index 100%
rename from docs/schemas/data-operation-event-schema-1.0.0.json
rename to docs/schemas/ncmp/async-m2m/data-operation-event-schema-1.0.0.json

diff --git a/docs/schemas/ncmp-async-request-response-event-schema-v1.json b/docs/schemas/ncmp/async-m2m/ncmp-async-request-response-event-schema-v1.json
similarity index 98%
rename from docs/schemas/ncmp-async-request-response-event-schema-v1.json
rename to docs/schemas/ncmp/async-m2m/ncmp-async-request-response-event-schema-v1.json
index 51c2cf4..32b7bec 100644 (file)
--- a/docs/schemas/ncmp-async-request-response-event-schema-v1.json
+++ b/docs/schemas/ncmp/async-m2m/ncmp-async-request-response-event-schema-v1.json
@@ -6,6 +6,7 @@
     "NcmpAsyncRequestResponseEvent": {
       "description": "The payload for CPS async request response event.",
       "type": "object",
+      "javaType" : "org.onap.cps.ncmp.event.model.NcmpAsyncRequestResponseEvent",
       "properties": {
         "eventId": {
           "description": "The unique id identifying the event generated by DMI.",

diff --git a/docs/schemas/ncmp-in-event-schema-1.0.0.json b/docs/schemas/ncmp/avc/ncmp-in-event-schema-1.0.0.json
similarity index 96%
rename from docs/schemas/ncmp-in-event-schema-1.0.0.json
rename to docs/schemas/ncmp/avc/ncmp-in-event-schema-1.0.0.json
index f8b6c2e..d4e8519 100644 (file)
--- a/docs/schemas/ncmp-in-event-schema-1.0.0.json
+++ b/docs/schemas/ncmp/avc/ncmp-in-event-schema-1.0.0.json
@@ -1,5 +1,5 @@
 {
-  "$id": "urn:cps:org.onap.cps.ncmp.events:cm-notification-subscription-ncmp-in-event:1.0.0",
+  "$id": "urn:cps:org.onap.ncmp.events.subscription:1.0.0",
   "$ref": "#/definitions/NcmpInEvent",
   "$schema": "https://json-schema.org/draft/2019-09/schema",
   "definitions": {

diff --git a/docs/schemas/ncmp-out-event-schema-1.0.0.json b/docs/schemas/ncmp/avc/ncmp-out-event-schema-1.0.0.json
similarity index 68%
rename from docs/schemas/ncmp-out-event-schema-1.0.0.json
rename to docs/schemas/ncmp/avc/ncmp-out-event-schema-1.0.0.json
index d6ef55d..f1dabc1 100644 (file)
--- a/docs/schemas/ncmp-out-event-schema-1.0.0.json
+++ b/docs/schemas/ncmp/avc/ncmp-out-event-schema-1.0.0.json
@@ -1,6 +1,6 @@
 {
   "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "$id": "urn:cps:org.onap.cps.ncmp.events:cm-notification-subscription-ncmp-out-event-schema:1.0.0",
+  "$id": "urn:cps:org.onap.ncmp.events.subscription:1.0.0",
   "$ref": "#/definitions/NcmpOutEvent",
   "definitions": {
     "NcmpOutEvent": {
@@ -28,25 +28,19 @@
           "description": "The unique subscription id"
         },
         "acceptedTargets": {
-          "type": "array",
-          "description": "List of accepted targets",
-          "items": {
-            "type": "string"
-          }
+          "type": "object",
+          "existingJavaType": "java.util.Collection<String>",
+          "description": "Collection of accepted targets"
         },
         "rejectedTargets": {
-          "type": "array",
-          "description": "List of rejected targets",
-          "items": {
-            "type": "string"
-          }
+          "type": "object",
+          "existingJavaType": "java.util.Collection<String>",
+          "description": "Collection of rejected targets"
         },
         "pendingTargets": {
-          "type": "array",
-          "description": "List of pending targets",
-          "items": {
-            "type": "string"
-          }
+          "type": "object",
+          "existingJavaType": "java.util.Collection<String>",
+          "description": "Collection of pending targets"
         }
       },
       "required": [