| sourabh_sourabh | 9a76aa3 | 2023-07-25 10:58:52 +0100 | [diff] [blame] | 1 | { |
| 2 | "$schema": "https://json-schema.org/draft/2019-09/schema", |
| 3 | "$id": "urn:cps:org.onap.cps.ncmp.events.async:data-operation-event-schema:1.0.0", |
| 4 | "$ref": "#/definitions/DataOperationEvent", |
| 5 | "definitions": { |
| 6 | "DataOperationEvent": { |
| 7 | "description": "The payload of data operation event.", |
| 8 | "type": "object", |
| 9 | "javaType" : "org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent", |
| 10 | "properties": { |
| 11 | "data": { |
| 12 | "description": "The payload content of the requested data.", |
| 13 | "type": "object", |
| 14 | "properties": { |
| 15 | "responses": { |
| 16 | "description": "An array of batch responses which contains both success and failure", |
| 17 | "type": "array", |
| 18 | "items": { |
| 19 | "type": "object", |
| 20 | "properties": { |
| 21 | "operationId": { |
| 22 | "description": "Used to distinguish multiple operations using same handle ids", |
| 23 | "type": "string" |
| 24 | }, |
| 25 | "ids": { |
| 26 | "description": "Id's of the cmhandles", |
| 27 | "type": "array", |
| 28 | "items": { |
| 29 | "type": "string" |
| 30 | } |
| 31 | }, |
| sourabh_sourabh | 0373f19 | 2023-08-16 13:16:25 +0100 | [diff] [blame] | 32 | "resourceIdentifier": { |
| 33 | "description": "The format of resource identifier depend on the associated DMI Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but it can really be anything.", |
| 34 | "type": "string" |
| 35 | }, |
| 36 | "options": { |
| 37 | "description": "It is mandatory to add as key(s)=value(s)'. The format of options parameter depend on the associated DMI Plugin implementation.", |
| 38 | "type": "string" |
| 39 | }, |
| sourabh_sourabh | 9a76aa3 | 2023-07-25 10:58:52 +0100 | [diff] [blame] | 40 | "statusCode": { |
| 41 | "description": "which says success or failure (0-99) are for success and (100-199) are for failure", |
| 42 | "type": "string" |
| 43 | }, |
| 44 | "statusMessage": { |
| 45 | "description": "Human readable message, Which says what the response has", |
| 46 | "type": "string" |
| 47 | }, |
| 48 | "result": { |
| 49 | "description": "Contains the requested data response.", |
| 50 | "type": "object", |
| 51 | "existingJavaType": "java.lang.Object", |
| 52 | "additionalProperties": false |
| 53 | } |
| 54 | }, |
| 55 | "required": [ |
| 56 | "operationId", |
| 57 | "ids", |
| 58 | "statusCode", |
| 59 | "statusMessage" |
| 60 | ], |
| 61 | "additionalProperties": false |
| 62 | } |
| 63 | } |
| 64 | }, |
| 65 | "required": [ |
| 66 | "responses" |
| 67 | ], |
| 68 | "additionalProperties": false |
| 69 | } |
| 70 | }, |
| 71 | "required": [ |
| 72 | "data" |
| 73 | ], |
| 74 | "additionalProperties": false |
| 75 | } |
| 76 | } |
| 77 | } |