summaryrefslogtreecommitdiffstats
path: root/cps-ncmp-events/src/main/resources/schemas/async/batch-event-schema-1.0.0.json
blob: da836ff167e3653cd867cb5ab023983b25bd74f7 (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
{
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$id": "urn:cps:org.onap.cps.ncmp.events.async:batch-event-schema:1.0.0",
  "$ref": "#/definitions/BatchDataResponseEvent",
  "definitions": {
    "BatchDataResponseEvent": {
      "description": "The payload of batch event.",
      "type": "object",
      "javaType" : "org.onap.cps.ncmp.events.async.BatchDataResponseEventV1",
      "properties": {
        "event": {
          "description": "The payload content of the requested data.",
          "type": "object",
          "javaType" : "org.onap.cps.ncmp.events.async.BatchDataEvent",
          "properties": {
            "batch-responses": {
              "description": "An array of batch responses which contains both success and failure",
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "operationId": {
                    "description": "Used to distinguish multiple operations using same cmhandleId",
                    "type": "string"
                  },
                  "ids": {
                    "description": "Id's of the cmhandles",
                    "type": "array"
                  },
                  "status-code": {
                    "description": "which says success or failure (0-99) are for success and (100-199) are for failure",
                    "type": "string"
                  },
                  "status-message": {
                    "description": "Human readable message, Which says what the response has",
                    "type": "string"
                  },
                  "data": {
                    "description": "Contains the requested data response.",
                    "type": "object",
                    "existingJavaType": "java.lang.Object",
                    "additionalProperties": false
                  }
                },
                "required": [
                  "operationId",
                  "ids",
                  "status-code",
                  "status-message"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "batch-responses"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "event"
      ],
      "additionalProperties": false
    }
  }
}