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