From 7a7f4882dd64cfae256dd15b7139450064aeeead Mon Sep 17 00:00:00 2001 From: mpriyank Date: Wed, 5 Jul 2023 16:14:34 +0100 Subject: NCMP to client schema for Subscription - added schema to comply with the agreed upon changes and it include capability to have statusCode and statusMessage as well. - Renamed existing schemas just for consistency Issue-ID: CPS-1739 Change-Id: I6bb1d13bf5c84ca812c5cf37062a168845d6be1d Signed-off-by: mpriyank --- .../client-to-ncmp-subscription-event-1.0.0.json | 99 ---------------------- ...nt-to-ncmp-subscription-event-schema-1.0.0.json | 99 ++++++++++++++++++++++ ...i-subscription-response-event-schema-1.0.0.json | 70 --------------- ...p-subscription-response-event-schema-1.0.0.json | 70 +++++++++++++++ ...nt-subscription-event-outcome-schema-1.0.0.json | 69 +++++++++++++++ 5 files changed, 238 insertions(+), 169 deletions(-) delete mode 100644 cps-ncmp-events/src/main/resources/schemas/subscription/client-to-ncmp-subscription-event-1.0.0.json create mode 100644 cps-ncmp-events/src/main/resources/schemas/subscription/client-to-ncmp-subscription-event-schema-1.0.0.json delete mode 100644 cps-ncmp-events/src/main/resources/schemas/subscription/dmi-subscription-response-event-schema-1.0.0.json create mode 100644 cps-ncmp-events/src/main/resources/schemas/subscription/dmi-to-ncmp-subscription-response-event-schema-1.0.0.json create mode 100644 cps-ncmp-events/src/main/resources/schemas/subscription/ncmp-to-client-subscription-event-outcome-schema-1.0.0.json (limited to 'cps-ncmp-events') diff --git a/cps-ncmp-events/src/main/resources/schemas/subscription/client-to-ncmp-subscription-event-1.0.0.json b/cps-ncmp-events/src/main/resources/schemas/subscription/client-to-ncmp-subscription-event-1.0.0.json deleted file mode 100644 index 2bbd09bad..000000000 --- a/cps-ncmp-events/src/main/resources/schemas/subscription/client-to-ncmp-subscription-event-1.0.0.json +++ /dev/null @@ -1,99 +0,0 @@ -{ - "$id": "urn:cps:org.onap.cps.ncmp.events:avc-subscription-event:1.0.0", - "$ref": "#/definitions/SubscriptionEvent", - "$schema": "https://json-schema.org/draft/2019-09/schema", - "definitions": { - "SubscriptionEvent": { - "description": "The payload for subscription event.", - "javaType": "org.onap.cps.ncmp.events.avcsubscription1_0_0.client_to_ncmp.SubscriptionEvent", - "properties": { - "data": { - "properties": { - "dataType": { - "description": "The datatype content.", - "properties": { - "dataCategory": { - "description": "The category type of the data", - "type": "string" - }, - "dataProvider": { - "description": "The provider name of the data", - "type": "string" - }, - "dataspace": { - "description": "The dataspace name", - "type": "string" - } - }, - "required": [ - "dataCategory", - "dataProvider", - "dataspace" - ], - "type": "object", - "additionalProperties": false - }, - "predicates": { - "description": "Additional values to be added into the subscription", - "properties": { - "datastore": { - "description": "datastore which is to be used by the subscription", - "type": "string" - }, - "targets": { - "description": "CM Handles to be targeted by the subscription", - "type": "array", - "items": { - "type": "string" - } - }, - "datastore-xpath-filter": { - "description": "filter to be applied to the CM Handles through this event", - "type": "string" - } - }, - "required": [ - "datastore", - "targets", - "datastore-xpath-filter" - ], - "type": "object", - "additionalProperties": false - }, - "subscription": { - "description": "The subscription details.", - "properties": { - "clientID": { - "description": "The clientID", - "type": "string" - }, - "name": { - "description": "The name of the subscription", - "type": "string" - } - }, - "required": [ - "clientID", - "name" - ], - "type": "object", - "additionalProperties": false - } - }, - "required": [ - "dataType", - "predicates", - "subscription" - ], - "type": "object", - "additionalProperties": false - } - }, - "type": "object", - "additionalProperties": false, - "required": [ - "data" - ] - } - } -} \ No newline at end of file diff --git a/cps-ncmp-events/src/main/resources/schemas/subscription/client-to-ncmp-subscription-event-schema-1.0.0.json b/cps-ncmp-events/src/main/resources/schemas/subscription/client-to-ncmp-subscription-event-schema-1.0.0.json new file mode 100644 index 000000000..2bbd09bad --- /dev/null +++ b/cps-ncmp-events/src/main/resources/schemas/subscription/client-to-ncmp-subscription-event-schema-1.0.0.json @@ -0,0 +1,99 @@ +{ + "$id": "urn:cps:org.onap.cps.ncmp.events:avc-subscription-event:1.0.0", + "$ref": "#/definitions/SubscriptionEvent", + "$schema": "https://json-schema.org/draft/2019-09/schema", + "definitions": { + "SubscriptionEvent": { + "description": "The payload for subscription event.", + "javaType": "org.onap.cps.ncmp.events.avcsubscription1_0_0.client_to_ncmp.SubscriptionEvent", + "properties": { + "data": { + "properties": { + "dataType": { + "description": "The datatype content.", + "properties": { + "dataCategory": { + "description": "The category type of the data", + "type": "string" + }, + "dataProvider": { + "description": "The provider name of the data", + "type": "string" + }, + "dataspace": { + "description": "The dataspace name", + "type": "string" + } + }, + "required": [ + "dataCategory", + "dataProvider", + "dataspace" + ], + "type": "object", + "additionalProperties": false + }, + "predicates": { + "description": "Additional values to be added into the subscription", + "properties": { + "datastore": { + "description": "datastore which is to be used by the subscription", + "type": "string" + }, + "targets": { + "description": "CM Handles to be targeted by the subscription", + "type": "array", + "items": { + "type": "string" + } + }, + "datastore-xpath-filter": { + "description": "filter to be applied to the CM Handles through this event", + "type": "string" + } + }, + "required": [ + "datastore", + "targets", + "datastore-xpath-filter" + ], + "type": "object", + "additionalProperties": false + }, + "subscription": { + "description": "The subscription details.", + "properties": { + "clientID": { + "description": "The clientID", + "type": "string" + }, + "name": { + "description": "The name of the subscription", + "type": "string" + } + }, + "required": [ + "clientID", + "name" + ], + "type": "object", + "additionalProperties": false + } + }, + "required": [ + "dataType", + "predicates", + "subscription" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object", + "additionalProperties": false, + "required": [ + "data" + ] + } + } +} \ No newline at end of file diff --git a/cps-ncmp-events/src/main/resources/schemas/subscription/dmi-subscription-response-event-schema-1.0.0.json b/cps-ncmp-events/src/main/resources/schemas/subscription/dmi-subscription-response-event-schema-1.0.0.json deleted file mode 100644 index ec968fd0c..000000000 --- a/cps-ncmp-events/src/main/resources/schemas/subscription/dmi-subscription-response-event-schema-1.0.0.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2019-09/schema", - "$id": "urn:cps:org.onap.cps.ncmp.events:dmi-subscription-response-event-schema:1.0.0", - "$ref": "#/definitions/SubscriptionEventResponse", - "definitions": { - "SubscriptionStatus": { - "description": "The subscription status information", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "status" : { - "type": "string", - "enum": [ - "ACCEPTED", - "REJECTED", - "PENDING" - ] - }, - "details" : { - "type": "string" - } - }, - "required": [ - "id", - "status" - ], - "additionalProperties": false - }, - "SubscriptionEventResponse" : { - "description": "The payload for subscription response event.", - "type": "object", - "javaType": "org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.SubscriptionEventResponse", - "properties": { - "data": { - "type": "object", - "properties": { - "clientId": { - "type": "string" - }, - "subscriptionName": { - "type": "string" - }, - "dmiName": { - "type": "string" - }, - "subscriptionStatus": { - "type": "array", - "items": { - "$ref": "#/definitions/SubscriptionStatus" - } - } - }, - "required": [ - "clientId", - "subscriptionName", - "dmiName", - "subscriptionStatus" - ], - "additionalProperties": false - } - }, - "additionalProperties": false, - "required": [ - "data" - ] - } - } -} \ No newline at end of file diff --git a/cps-ncmp-events/src/main/resources/schemas/subscription/dmi-to-ncmp-subscription-response-event-schema-1.0.0.json b/cps-ncmp-events/src/main/resources/schemas/subscription/dmi-to-ncmp-subscription-response-event-schema-1.0.0.json new file mode 100644 index 000000000..ec968fd0c --- /dev/null +++ b/cps-ncmp-events/src/main/resources/schemas/subscription/dmi-to-ncmp-subscription-response-event-schema-1.0.0.json @@ -0,0 +1,70 @@ +{ + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "urn:cps:org.onap.cps.ncmp.events:dmi-subscription-response-event-schema:1.0.0", + "$ref": "#/definitions/SubscriptionEventResponse", + "definitions": { + "SubscriptionStatus": { + "description": "The subscription status information", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "status" : { + "type": "string", + "enum": [ + "ACCEPTED", + "REJECTED", + "PENDING" + ] + }, + "details" : { + "type": "string" + } + }, + "required": [ + "id", + "status" + ], + "additionalProperties": false + }, + "SubscriptionEventResponse" : { + "description": "The payload for subscription response event.", + "type": "object", + "javaType": "org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.SubscriptionEventResponse", + "properties": { + "data": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "subscriptionName": { + "type": "string" + }, + "dmiName": { + "type": "string" + }, + "subscriptionStatus": { + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionStatus" + } + } + }, + "required": [ + "clientId", + "subscriptionName", + "dmiName", + "subscriptionStatus" + ], + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "data" + ] + } + } +} \ No newline at end of file diff --git a/cps-ncmp-events/src/main/resources/schemas/subscription/ncmp-to-client-subscription-event-outcome-schema-1.0.0.json b/cps-ncmp-events/src/main/resources/schemas/subscription/ncmp-to-client-subscription-event-outcome-schema-1.0.0.json new file mode 100644 index 000000000..a2017b466 --- /dev/null +++ b/cps-ncmp-events/src/main/resources/schemas/subscription/ncmp-to-client-subscription-event-outcome-schema-1.0.0.json @@ -0,0 +1,69 @@ +{ + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "urn:cps:org.onap.cps.ncmp.events:subscription-event-outcome-schema:1.0.0", + "$ref": "#/definitions/SubscriptionEventOutcome", + "definitions": { + "SubscriptionEventOutcome": { + "description": "The payload for avc subscription event outcome message.", + "type": "object", + "javaType": "org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_client.SubscriptionEventOutcome", + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/definitions/data" + } + }, + "required": [ + "data" + ] + }, + "data": { + "type": "object", + "description": "The actual data containing information about the pending and rejected targets", + "additionalProperties": false, + "properties": { + "statusCode": { + "type": "integer" + }, + "statusMessage": { + "type": "string" + }, + "additionalInfo": { + "type": "object", + "additionalProperties": false, + "properties": { + "rejected": { + "$ref": "#/definitions/additionalInfoDetails" + }, + "pending": { + "$ref": "#/definitions/additionalInfoDetails" + } + } + } + }, + "required": [ + "statusCode", + "statusMessage" + ] + }, + "additionalInfoDetails": { + "type": "array", + "items": { + "type": "object", + "description": "Details for the target cmhandles", + "additionalProperties": false, + "properties": { + "details": { + "type": "string" + }, + "targets": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } +} \ No newline at end of file -- cgit 1.2.3-korg