summaryrefslogtreecommitdiffstats
path: root/cps-ncmp-events/src/main/resources/schemas/ncmp-event-schema-v1.json
blob: 84fc12edbd0aeb8b8a38976dadb6b3a530b658a0 (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
{

  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$id": "urn:cps:org.onap.ncmp.cmhandle.lcm-event:v1",

  "$ref": "#/definitions/NcmpEvent",

  "definitions": {

    "NcmpEvent": {
      "description": "The payload for NCMP event.",
      "type": "object",
      "javaType" : "org.onap.ncmp.cmhandle.lcm.event.NcmpEvent",
      "properties": {
        "eventId": {
          "description": "The unique id identifying the event for the specified source.",
          "type": "string"
        },
        "eventCorrelationId": {
          "description": "The id identifying the event for the specified source.",
          "type": "string"
        },
        "eventTime": {
          "description": "The timestamp when the data has been observed.",
          "type": "string"
        },
        "eventSource": {
          "description": "The source of the event.",
          "type": "string",
          "format": "uri"
        },
        "eventType": {
          "description": "The type of the event.",
          "type": "string"
        },
        "eventSchema": {
          "description": "The schema, including its version, that this event adheres to.",
          "type": "string",
          "format": "uri"
        },
        "event": {
          "$ref": "#/definitions/Event"
        }
      },
      "required": [
        "eventId",
        "eventTime",
        "eventSource",
        "eventType",
        "eventSchema",
        "event"
      ],
      "additionalProperties": false
    },

    "Event": {
      "description": "The Payload of an event.",
      "type": "object",
      "properties": {
        "cmHandleId": {
          "description": "cmHandle id",
          "type": "string"
        },
        "operation": {
          "description": "The name of the Operation that triggered this event.",
          "type": "string",
          "enum": ["CREATE", "UPDATE", "DELETE"]
        },
        "cmhandle-state": {
          "description": "State of cmHandle.",
          "type": "string",
          "enum": ["ADVISED", "READY", "LOCKED"]
        },
        "cmhandle-properties": {
          "description": "cmHandle properties as json object.",
          "type": "object",
          "existingJavaType": "java.util.List<java.util.Map<String,String>>",
          "additionalProperties": false
        }
      },
      "required": [
        "operation"
      ],
      "additionalProperties": false
    }
  }
}