cps-ncmp-events/src/main/resources/schemas/async/batch-event-schema-1.0.0.json

   1 {
   2   "$schema": "https://json-schema.org/draft/2019-09/schema",
   3   "$id": "urn:cps:org.onap.cps.ncmp.events.async:batch-event-schema:1.0.0",
   4   "$ref": "#/definitions/BatchDataResponseEvent",
   5   "definitions": {
   6     "BatchDataResponseEvent": {
   7       "description": "The payload of batch event.",
   8       "type": "object",
   9       "javaType" : "org.onap.cps.ncmp.events.async.BatchDataResponseEventV1",
  10       "properties": {
  11         "event": {
  12           "description": "The payload content of the requested data.",
  13           "type": "object",
  14           "javaType" : "org.onap.cps.ncmp.events.async.BatchDataEvent",
  15           "properties": {
  16             "batch-responses": {
  17               "description": "An array of batch responses which contains both success and failure",
  18               "type": "array",
  19               "items": {
  20                 "type": "object",
  21                 "properties": {
  22                   "operationId": {
  23                     "description": "Used to distinguish multiple operations using same cmhandleId",
  24                     "type": "string"
  25                   },
  26                   "ids": {
  27                     "description": "Id's of the cmhandles",
  28                     "type": "array"
  29                   },
  30                   "status-code": {
  31                     "description": "which says success or failure (0-99) are for success and (100-199) are for failure",
  32                     "type": "string"
  33                   },
  34                   "status-message": {
  35                     "description": "Human readable message, Which says what the response has",
  36                     "type": "string"
  37                   },
  38                   "data": {
  39                     "description": "Contains the requested data response.",
  40                     "type": "object",
  41                     "existingJavaType": "java.lang.Object",
  42                     "additionalProperties": false
  43                   }
  44                 },
  45                 "required": [
  46                   "operationId",
  47                   "ids",
  48                   "status-code",
  49                   "status-message"
  50                 ],
  51                 "additionalProperties": false
  52               }
  53             }
  54           },
  55           "required": [
  56             "batch-responses"
  57           ],
  58           "additionalProperties": false
  59         }
  60       },
  61       "required": [
  62         "event"
  63       ],
  64       "additionalProperties": false
  65     }
  66   }
  67 }