aboutsummaryrefslogtreecommitdiffstats
path: root/cps-ncmp-events/src/main/resources/schemas/ncmp-async-request-response-event-schema-v1.json
blob: 51c2cf4d400563ddcc0661bdff050a4845d485fe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
{
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$id": "urn:cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1",
  "$ref": "#/definitions/NcmpAsyncRequestResponseEvent",
  "definitions": {
    "NcmpAsyncRequestResponseEvent": {
      "description": "The payload for CPS async request response event.",
      "type": "object",
      "properties": {
        "eventId": {
          "description": "The unique id identifying the event generated by DMI.",
          "type": "string"
        },
        "eventCorrelationId": {
          "description": "The request id passed by NCMP.",
          "type": "string"
        },
        "eventTime": {
          "description": "The time of the event. The expected format is 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'.",
          "type": "string"
        },
        "eventTarget": {
          "description": "The target of the event.",
          "type": "string"
        },
        "eventType": {
          "description": "The type of the event.",
          "type": "string"
        },
        "eventSchema": {
          "description": "The event schema for async request response events.",
          "type": "string"
        },
        "eventSchemaVersion": {
          "description": "The event schema version for async request response events.",
          "type": "string"
        },
        "event": {
        "$ref": "#/definitions/Event"
        },
        "forwardedEvent": {
          "$ref": "#/definitions/Forwarded-Event"
        }
      },
      "required": [
        "eventId",
        "eventCorrelationId",
        "eventTime",
        "eventTarget",
        "eventType",
        "eventSchema",
        "eventSchemaVersion"
      ]
    },
    "Forwarded-Event": {
      "description": "The event content.",
      "type": "object",
      "properties": {
        "eventId": {
          "description": "The unique id identifying the event generated by DMI.",
          "type": "string"
        },
        "eventCorrelationId": {
          "description": "The request id passed by NCMP.",
          "type": "string"
        },
        "eventTime": {
          "description": "The time of the event. The expected format is 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'.",
          "type": "string"
        },
        "eventTarget": {
          "description": "The target of the event.",
          "type": "string"
        },
        "eventType": {
          "description": "The type of the event.",
          "type": "string"
        },
        "eventSchema": {
          "description": "The event schema for async request response events.",
          "type": "string"
        },
        "eventSchemaVersion": {
          "description": "The event schema version for async request response events.",
          "type": "string"
        },
        "eventSource": {
          "description": "The source of the event.",
          "type": "string"
        },
        "response-data-schema": {
          "description": "The received schema of response data",
          "type": "string"
        },
        "response-status": {
          "description": "The received status of the response.",
          "type": "string"
        },
        "response-code": {
          "description": "The received code of the response.",
          "type": "string"
        },
        "forwardedEventData": {
          "description": "The data payload",
          "type": "object",
          "properties": {
            "forwardedEventPayload": {
              "type": "object"
            }
          }
        },
        "required": [
          "eventId",
          "eventCorrelationId",
          "eventTime",
          "eventTarget",
          "eventType",
          "eventSchema",
          "eventSchemaVersion",
          "eventSource",
          "response-data-schema",
          "response-status",
          "response-code",
          "forwardedEventData"
        ]
      }
    },
    "Event": {
      "description": "The event content.",
      "type": "object",
      "properties": {
        "eventId": {
          "description": "The unique id identifying the event generated by DMI",
          "type": "string"
        },
        "eventCorrelationId": {
          "description": "The request id passed by NCMP.",
          "type": "string"
        },
        "eventTime": {
          "description": "The time of the event. The expected format is 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'.",
          "type": "string"
        },
        "eventTarget": {
          "description": "The target of the event.",
          "type": "string"
        },
        "eventType": {
          "description": "The type of the event.",
          "type": "string"
        },
        "eventSchema": {
          "description": "The event schema for async request response events.",
          "type": "string"
        },
        "eventSource": {
          "description": "The source of the event.",
          "type": "string"
        },
        "response-data-schema": {
          "description": "The received schema of response data",
          "type": "string"
        },
        "response-status": {
          "description": "The received status of the response.",
          "type": "string"
        },
        "response-code": {
          "description": "The received code of the response.",
          "type": "string"
        },
        "response-data": {
          "description": "The data payload",
          "type": "object",
          "properties": {
            "payload": {
              "type": "object"
            }
          }
        },
        "required": [
          "eventId",
          "eventCorrelationId",
          "eventTarget",
          "eventTime",
          "eventType",
          "eventSchema",
          "eventSource",
          "response-data-schema",
          "response-status",
          "response-code",
          "event-data"
        ]
      }
    }
  }
}