summaryrefslogtreecommitdiffstats
path: root/cps-ncmp-events/src/main/resources/schemas/dmi-async-request-response-event-schema-v1.json
blob: 2340a4bc4ccdeabed607969298e12a0584843262 (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
{
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$id": "urn:cps:org.onap.cps.ncmp.events:dmi-async-request-response-event-schema:v1",
  "$ref": "#/definitions/DmiAsyncRequestResponseEvent",
  "definitions": {
    "DmiAsyncRequestResponseEvent": {
      "description": "The payload for NCMP 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"
        },
        "eventSource": {
          "description": "The source of the event.",
          "type": "string"
        },
        "eventContent": {
          "$ref": "#/definitions/Event-Content"
        }
      },
      "required": [
        "eventId",
        "eventCorrelationId",
        "eventTime",
        "eventTarget",
        "eventType",
        "eventSchema",
        "eventSchemaVersion",
        "eventSource",
        "eventContent"
      ]
    },
    "Event-Content": {
      "description": "The event content.",
      "type": "object",
      "properties": {
        "response-data-schema": {
          "description": "The schema of response data",
          "type": "string"
        },
        "response-status": {
          "description": "The status of the response.",
          "type": "string"
        },
        "response-code": {
          "description": "The code of the response.",
          "type": "string"
        },
        "response-data": {
          "description": "The data payload",
          "type": "object",
          "properties": {
            "payload": {
              "type": "object"
            }
          }
        },
        "required": [
          "response-data-schema",
          "response-status",
          "response-code",
          "response-data"
        ]
      }
    }
  }
}