aboutsummaryrefslogtreecommitdiffstats
path: root/docs/schemas
diff options
context:
space:
mode:
authorLee Anjella Macabuhay <lee.anjella.macabuhay@est.tech>2025-03-03 13:48:48 +0000
committerGerrit Code Review <gerrit@onap.org>2025-03-03 13:48:48 +0000
commit5a0ac4617333a70d7409ca08910db1bb9a217a37 (patch)
tree42dc413d969c9cecc32e250af4011941576e7c90 /docs/schemas
parentd2e5a379840ceac8ae798546b3abf40f678d9f3a (diff)
parent4b6efbbe9fa905a3ee4bc6e7ae5ced2ddd079fb8 (diff)
Merge "RTD update related to event schemas"
Diffstat (limited to 'docs/schemas')
-rw-r--r--docs/schemas/dmi/cm-events/avc-event-schema-1.0.0.json (renamed from docs/schemas/dmidataavc/avc-event-schema-1.0.0.json)0
-rw-r--r--docs/schemas/lcm/lcm-event-header-v1.json56
-rw-r--r--docs/schemas/lcm/lcm-event-schema-v1.json (renamed from docs/schemas/lcm-event-schema-v1.json)14
-rw-r--r--docs/schemas/ncmp/async-m2m/data-operation-event-schema-1.0.0.json (renamed from docs/schemas/data-operation-event-schema-1.0.0.json)0
-rw-r--r--docs/schemas/ncmp/async-m2m/ncmp-async-request-response-event-schema-v1.json (renamed from docs/schemas/ncmp-async-request-response-event-schema-v1.json)1
-rw-r--r--docs/schemas/ncmp/avc/ncmp-in-event-schema-1.0.0.json (renamed from docs/schemas/ncmp-in-event-schema-1.0.0.json)2
-rw-r--r--docs/schemas/ncmp/avc/ncmp-out-event-schema-1.0.0.json (renamed from docs/schemas/ncmp-out-event-schema-1.0.0.json)26
7 files changed, 81 insertions, 18 deletions
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
index 474520d142..474520d142 100644
--- a/docs/schemas/dmidataavc/avc-event-schema-1.0.0.json
+++ b/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
index 0000000000..8c9922ef7e
--- /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
index 97c0fbee22..bd0d90d04a 100644
--- 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
index c2915187c7..c2915187c7 100644
--- 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
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
index 51c2cf4d40..32b7becd05 100644
--- 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
index f8b6c2e680..d4e8519956 100644
--- 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
index d6ef55d063..f1dabc17a3 100644
--- 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": [