cps-ncmp-events/src/main/resources/schemas/avc-subscription-event-v1.json

   1 {
   2   "$schema": "https://json-schema.org/draft/2019-09/schema",
   3   "$id": "urn:cps:org.onap.cps.ncmp.events:avc-subscription-event:v1",
   4   "$ref": "#/definitions/SubscriptionEvent",
   5   "definitions": {
   6     "SubscriptionEvent": {
   7       "description": "The payload for avc subscription event.",
   8       "type": "object",
   9       "properties": {
  10         "version": {
  11           "description": "The event type version",
  12           "type": "string"
  13         },
  14         "eventType": {
  15           "description": "The event type",
  16           "type": "string",
  17           "enum": ["CREATE"]
  18         },
  19         "event": {
  20           "$ref": "#/definitions/event"
  21         }
  22       },
  23       "required": [
  24         "version",
  25         "eventContent"
  26       ],
  27       "additionalProperties": false
  28     },
  29     "event": {
  30       "description": "The event content.",
  31       "type": "object",
  32       "javaType": "InnerSubscriptionEvent",
  33       "properties": {
  34         "subscription": {
  35           "description": "The subscription details.",
  36           "type": "object",
  37           "properties": {
  38             "clientID": {
  39               "description": "The clientID",
  40               "type": "string"
  41             },
  42             "name": {
  43               "description": "The name of the subscription",
  44               "type": "string"
  45             },
  46             "isTagged": {
  47               "description": "optional parameter, default is no",
  48               "type": "boolean",
  49               "default": false
  50             }
  51           },
  52           "required": [
  53             "clientID",
  54             "name"
  55           ]
  56         },
  57         "dataType": {
  58           "description": "The datatype content.",
  59           "type": "object",
  60           "properties": {
  61             "dataspace": {
  62               "description": "The dataspace name",
  63               "type": "string"
  64             },
  65             "dataCategory": {
  66               "description": "The category type of the data",
  67               "type": "string"
  68             },
  69             "dataProvider": {
  70               "description": "The provider name of the data",
  71               "type": "string"
  72             },
  73             "schemaName": {
  74               "description": "The name of the schema",
  75               "type": "string"
  76             },
  77             "schemaVersion": {
  78               "description": "The version of the schema",
  79               "type": "string"
  80             }
  81           }
  82         },
  83         "required": [
  84           "dataspace",
  85           "dataCategory",
  86           "dataProvider",
  87           "schemaName",
  88           "schemaVersion"
  89         ],
  90         "predicates": {
  91           "description": "Additional values to be added into the subscription",
  92           "type" : "object",
  93           "properties": {
  94             "targets": {
  95               "description": "CM Handles to be targeted by the subscription",
  96               "type" : "array"
  97             },
  98             "datastore": {
  99               "description": "datastore which is to be used by the subscription",
 100               "type": "string"
 101             },
 102             "xpath-filter": {
 103               "description": "filter to be applied to the CM Handles through this event",
 104               "type": "string"
 105             }
 106           },
 107           "required": ["datastore"]
 108         }
 109       }
 110     },
 111     "required": [
 112         "subscription",
 113         "dataType"
 114       ]
 115     }
 116 }