summaryrefslogtreecommitdiffstats
path: root/docs/schemas
diff options
context:
space:
mode:
authorsourabh_sourabh <sourabh.sourabh@est.tech>2023-07-25 10:58:52 +0100
committersourabh_sourabh <sourabh.sourabh@est.tech>2023-07-27 13:32:59 +0100
commit9a76aa39090d0bcbbc41e78c80c2769aa1c5f6d1 (patch)
tree1869f590dd1c915a66b09286ed90e13dded971b1 /docs/schemas
parent0eb490aaf48c2abe1f9d911f080bf14692968d80 (diff)
Update RTD (CPS-1515: Spike: Support Multiple CM-Handles for NCMP Get Operation)
- Added information about data operation NCMP endpoint and kafka event details. - Re-structured "CPS-Events" and "Modeling" page. Issue-ID:CPS-1785 Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech> Change-Id: I2b077ccd7ccd6144a8f9f2183d927f922075f532 Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
Diffstat (limited to 'docs/schemas')
-rw-r--r--docs/schemas/data-operation-event-schema-1.0.0.json69
1 files changed, 69 insertions, 0 deletions
diff --git a/docs/schemas/data-operation-event-schema-1.0.0.json b/docs/schemas/data-operation-event-schema-1.0.0.json
new file mode 100644
index 0000000000..f82e481415
--- /dev/null
+++ b/docs/schemas/data-operation-event-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.async:data-operation-event-schema:1.0.0",
+ "$ref": "#/definitions/DataOperationEvent",
+ "definitions": {
+ "DataOperationEvent": {
+ "description": "The payload of data operation event.",
+ "type": "object",
+ "javaType" : "org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent",
+ "properties": {
+ "data": {
+ "description": "The payload content of the requested data.",
+ "type": "object",
+ "properties": {
+ "responses": {
+ "description": "An array of batch responses which contains both success and failure",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "operationId": {
+ "description": "Used to distinguish multiple operations using same handle ids",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Id's of the cmhandles",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "statusCode": {
+ "description": "which says success or failure (0-99) are for success and (100-199) are for failure",
+ "type": "string"
+ },
+ "statusMessage": {
+ "description": "Human readable message, Which says what the response has",
+ "type": "string"
+ },
+ "result": {
+ "description": "Contains the requested data response.",
+ "type": "object",
+ "existingJavaType": "java.lang.Object",
+ "additionalProperties": false
+ }
+ },
+ "required": [
+ "operationId",
+ "ids",
+ "statusCode",
+ "statusMessage"
+ ],
+ "additionalProperties": false
+ }
+ }
+ },
+ "required": [
+ "responses"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "required": [
+ "data"
+ ],
+ "additionalProperties": false
+ }
+ }
+} \ No newline at end of file