Async request response NCMP -> Client
[cps.git] / cps-ncmp-events / src / main / resources / schemas / dmi-async-request-response-event-schema-v1.json
1 {
2   "$schema": "https://json-schema.org/draft/2019-09/schema",
3   "$id": "urn:cps:org.onap.cps.ncmp.events:dmi-async-request-response-event-schema:v1",
4   "$ref": "#/definitions/DmiAsyncRequestResponseEvent",
5   "definitions": {
6     "DmiAsyncRequestResponseEvent": {
7       "description": "The payload for NCMP async request response event.",
8       "type": "object",
9       "properties": {
10         "eventId": {
11           "description": "The unique id identifying the event generated by DMI.",
12           "type": "string"
13         },
14         "eventCorrelationId": {
15           "description": "The request id passed by NCMP.",
16           "type": "string"
17         },
18         "eventTime": {
19           "description": "The time of the event. The expected format is 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'.",
20           "type": "string"
21         },
22         "eventTarget": {
23           "description": "The target of the event.",
24           "type": "string"
25         },
26         "eventType": {
27           "description": "The type of the event.",
28           "type": "string"
29         },
30         "eventSchema": {
31           "description": "The event schema for async request response events.",
32           "type": "string"
33         },
34         "eventSource": {
35           "description": "The source of the event.",
36           "type": "string"
37         },
38         "eventContent": {
39           "$ref": "#/definitions/Event-Content"
40         }
41       },
42       "required": [
43         "eventId",
44         "eventCorrelationId",
45         "eventTime",
46         "eventTarget",
47         "eventType",
48         "eventSchema",
49         "eventSource",
50         "eventContent"
51       ]
52     },
53     "Event-Content": {
54       "description": "The event content.",
55       "type": "object",
56       "properties": {
57         "response-data-schema": {
58           "description": "The schema of response data",
59           "type": "string"
60         },
61         "response-status": {
62           "description": "The status of the response.",
63           "type": "string"
64         },
65         "response-code": {
66           "description": "The code of the response.",
67           "type": "string"
68         },
69         "response-data": {
70           "description": "The data payload",
71           "type": "object",
72           "properties": {
73             "payload": {
74               "type": "object"
75             }
76           }
77         },
78         "required": [
79           "response-data-schema",
80           "response-status",
81           "response-code",
82           "response-data"
83         ]
84       }
85     }
86   }
87 }