osm_nbi/validation.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #    http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  12 # implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 from jsonschema import validate as js_v, exceptions as js_e
  17 from http import HTTPStatus
  18 from copy import deepcopy
  19 from uuid import UUID  # To test for valid UUID
  20
  21 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
  22 __version__ = "0.1"
  23 version_date = "Mar 2018"
  24
  25 """
  26 Validator of input data using JSON schemas for those items that not contains an  OSM yang information model
  27 """
  28
  29 # Basis schemas
  30 patern_name = "^[ -~]+$"
  31 shortname_schema = {
  32     "type": "string",
  33     "minLength": 1,
  34     "maxLength": 60,
  35     "pattern": "^[^,;()\\.\\$'\"]+$",
  36 }
  37 passwd_schema = {"type": "string", "minLength": 1, "maxLength": 60}
  38 name_schema = {
  39     "type": "string",
  40     "minLength": 1,
  41     "maxLength": 255,
  42     "pattern": "^[^,;()'\"]+$",
  43 }
  44 string_schema = {"type": "string", "minLength": 1, "maxLength": 255}
  45 xml_text_schema = {
  46     "type": "string",
  47     "minLength": 1,
  48     "maxLength": 1000,
  49     "pattern": "^[^']+$",
  50 }
  51 description_schema = {
  52     "type": ["string", "null"],
  53     "maxLength": 255,
  54     "pattern": "^[^'\"]+$",
  55 }
  56 long_description_schema = {
  57     "type": ["string", "null"],
  58     "maxLength": 3000,
  59     "pattern": "^[^'\"]+$",
  60 }
  61 id_schema_fake = {"type": "string", "minLength": 2, "maxLength": 36}
  62 bool_schema = {"type": "boolean"}
  63 null_schema = {"type": "null"}
  64 # "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
  65 id_schema = {
  66     "type": "string",
  67     "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$",
  68 }
  69 time_schema = {
  70     "type": "string",
  71     "pattern": "^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]([0-5]:){2}",
  72 }
  73 pci_schema = {
  74     "type": "string",
  75     "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\\.[0-9a-fA-F]$",
  76 }
  77 # allows [] for wildcards. For that reason huge length limit is set
  78 pci_extended_schema = {"type": "string", "pattern": "^[0-9a-fA-F.:-\\[\\]]{12,40}$"}
  79 http_schema = {"type": "string", "pattern": "^(https?|http)://[^'\"=]+$"}
  80 bandwidth_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"}
  81 memory_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"}
  82 integer0_schema = {"type": "integer", "minimum": 0}
  83 integer1_schema = {"type": "integer", "minimum": 1}
  84 path_schema = {"type": "string", "pattern": "^(\\.){0,2}(/[^/\"':{}\\(\\)]+)+$"}
  85 vlan_schema = {"type": "integer", "minimum": 1, "maximum": 4095}
  86 vlan1000_schema = {"type": "integer", "minimum": 1000, "maximum": 4095}
  87 mac_schema = {
  88     "type": "string",
  89     "pattern": "^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$",
  90 }  # must be unicast: LSB bit of MSB byte ==0
  91 dpid_Schema = {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"}
  92 # mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
  93 ip_schema = {
  94     "type": "string",
  95     "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
  96 }
  97 ipv6_schema = {
  98     "type": "string",
  99     "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))",
 100 }
 101 ip_prefix_schema = {
 102     "type": "string",
 103     "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}"
 104     "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$",
 105 }
 106 port_schema = {"type": "integer", "minimum": 1, "maximum": 65534}
 107 object_schema = {"type": "object"}
 108 schema_version_2 = {"type": "integer", "minimum": 2, "maximum": 2}
 109 # schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
 110 log_level_schema = {
 111     "type": "string",
 112     "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
 113 }
 114 checksum_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{32}$"}
 115 size_schema = {"type": "integer", "minimum": 1, "maximum": 100}
 116 array_edition_schema = {
 117     "type": "object",
 118     "patternProperties": {"^\\$": {}},
 119     "additionalProperties": False,
 120     "minProperties": 1,
 121 }
 122 nameshort_list_schema = {
 123     "type": "array",
 124     "minItems": 1,
 125     "items": shortname_schema,
 126 }
 127
 128 description_list_schema = {
 129     "type": "array",
 130     "minItems": 1,
 131     "items": description_schema,
 132 }
 133
 134 ns_instantiate_vdu = {
 135     "title": "ns action instantiate input schema for vdu",
 136     "$schema": "http://json-schema.org/draft-04/schema#",
 137     "type": "object",
 138     "properties": {
 139         "id": name_schema,
 140         "volume": {
 141             "type": "array",
 142             "minItems": 1,
 143             "items": {
 144                 "type": "object",
 145                 "properties": {
 146                     "name": name_schema,
 147                     "vim-volume-id": name_schema,
 148                 },
 149                 "required": ["name", "vim-volume-id"],
 150                 "additionalProperties": False,
 151             },
 152         },
 153         "interface": {
 154             "type": "array",
 155             "minItems": 1,
 156             "items": {
 157                 "type": "object",
 158                 "properties": {
 159                     "name": name_schema,
 160                     "ip-address": {"oneOf": [ip_schema, ipv6_schema]},
 161                     "mac-address": mac_schema,
 162                     "floating-ip-required": bool_schema,
 163                 },
 164                 "required": ["name"],
 165                 "additionalProperties": False,
 166             },
 167         },
 168     },
 169     "required": ["id"],
 170     "additionalProperties": False,
 171 }
 172
 173 ip_profile_dns_schema = {
 174     "type": "array",
 175     "minItems": 1,
 176     "items": {
 177         "type": "object",
 178         "properties": {
 179             "address": {"oneOf": [ip_schema, ipv6_schema]},
 180         },
 181         "required": ["address"],
 182         "additionalProperties": False,
 183     },
 184 }
 185
 186 ip_profile_dhcp_schema = {
 187     "type": "object",
 188     "properties": {
 189         "enabled": {"type": "boolean"},
 190         "count": integer1_schema,
 191         "start-address": ip_schema,
 192     },
 193     "additionalProperties": False,
 194 }
 195
 196 ip_profile_schema = {
 197     "title": "ip profile validation schema",
 198     "$schema": "http://json-schema.org/draft-04/schema#",
 199     "type": "object",
 200     "properties": {
 201         "ip-version": {"enum": ["ipv4", "ipv6"]},
 202         "subnet-address": ip_prefix_schema,
 203         "gateway-address": ip_schema,
 204         "dns-server": ip_profile_dns_schema,
 205         "dhcp-params": ip_profile_dhcp_schema,
 206     },
 207 }
 208
 209 ip_profile_update_schema = {
 210     "title": "ip profile validation schema",
 211     "$schema": "http://json-schema.org/draft-04/schema#",
 212     "type": "object",
 213     "properties": {
 214         "ip-version": {"enum": ["ipv4", "ipv6"]},
 215         "subnet-address": {"oneOf": [null_schema, ip_prefix_schema]},
 216         "gateway-address": {"oneOf": [null_schema, ip_schema]},
 217         "dns-server": {"oneOf": [null_schema, ip_profile_dns_schema]},
 218         "dhcp-params": {"oneOf": [null_schema, ip_profile_dhcp_schema]},
 219     },
 220     "additionalProperties": False,
 221 }
 222
 223 provider_network_schema = {
 224     "title": "provider network validation schema",
 225     "$schema": "http://json-schema.org/draft-04/schema#",
 226     "type": "object",
 227     "properties": {
 228         "physical-network": name_schema,
 229         "segmentation-id": name_schema,
 230         "sdn-ports": {  # external ports to append to the SDN-assist network
 231             "type": "array",
 232             "items": {
 233                 "type": "object",
 234                 "properties": {
 235                     "switch_id": shortname_schema,
 236                     "switch_port": shortname_schema,
 237                     "mac_address": mac_schema,
 238                     "vlan": vlan_schema,
 239                 },
 240                 "additionalProperties": True,
 241             },
 242         },
 243         "network-type": shortname_schema,
 244     },
 245     "additionalProperties": True,
 246 }
 247
 248 ns_instantiate_internal_vld = {
 249     "title": "ns action instantiate input schema for vld",
 250     "$schema": "http://json-schema.org/draft-04/schema#",
 251     "type": "object",
 252     "properties": {
 253         "name": name_schema,
 254         "vim-network-name": name_schema,
 255         "vim-network-id": name_schema,
 256         "ip-profile": ip_profile_update_schema,
 257         "provider-network": provider_network_schema,
 258         "internal-connection-point": {
 259             "type": "array",
 260             "minItems": 1,
 261             "items": {
 262                 "type": "object",
 263                 "properties": {
 264                     "id-ref": name_schema,
 265                     "ip-address": ip_schema,
 266                     # "mac-address": mac_schema,
 267                 },
 268                 "required": ["id-ref"],
 269                 "minProperties": 2,
 270                 "additionalProperties": False,
 271             },
 272         },
 273     },
 274     "required": ["name"],
 275     "minProperties": 2,
 276     "additionalProperties": False,
 277 }
 278
 279 additional_params_for_vnf = {
 280     "type": "array",
 281     "items": {
 282         "type": "object",
 283         "properties": {
 284             "member-vnf-index": name_schema,
 285             "additionalParams": object_schema,
 286             "k8s-namespace": name_schema,
 287             "config-units": integer1_schema,  # number of configuration units of this vnf, by default 1
 288             "additionalParamsForVdu": {
 289                 "type": "array",
 290                 "items": {
 291                     "type": "object",
 292                     "properties": {
 293                         "vdu_id": name_schema,
 294                         "additionalParams": object_schema,
 295                         "config-units": integer1_schema,  # number of configuration units of this vdu, by default 1
 296                     },
 297                     "required": ["vdu_id"],
 298                     "minProperties": 2,
 299                     "additionalProperties": False,
 300                 },
 301             },
 302             "additionalParamsForKdu": {
 303                 "type": "array",
 304                 "items": {
 305                     "type": "object",
 306                     "properties": {
 307                         "kdu_name": name_schema,
 308                         "additionalParams": object_schema,
 309                         "kdu_model": name_schema,
 310                         "k8s-namespace": name_schema,
 311                         "config-units": integer1_schema,  # number of configuration units of this knf, by default 1
 312                         "kdu-deployment-name": name_schema,
 313                     },
 314                     "required": ["kdu_name"],
 315                     "minProperties": 2,
 316                     "additionalProperties": False,
 317                 },
 318             },
 319             "affinity-or-anti-affinity-group": {
 320                 "type": "array",
 321                 "items": {
 322                     "type": "object",
 323                     "properties": {
 324                         "id": name_schema,
 325                         "vim-affinity-group-id": name_schema,
 326                     },
 327                     "required": ["id"],
 328                     "minProperties": 2,
 329                     "additionalProperties": False,
 330                 },
 331             },
 332         },
 333         "required": ["member-vnf-index"],
 334         "minProperties": 2,
 335         "additionalProperties": False,
 336     },
 337 }
 338
 339 ns_instantiate = {
 340     "title": "ns action instantiate input schema",
 341     "$schema": "http://json-schema.org/draft-04/schema#",
 342     "type": "object",
 343     "properties": {
 344         "lcmOperationType": string_schema,
 345         "nsInstanceId": id_schema,
 346         "netsliceInstanceId": id_schema,
 347         "nsName": name_schema,
 348         "nsDescription": {"oneOf": [description_schema, null_schema]},
 349         "nsdId": id_schema,
 350         "vimAccountId": id_schema,
 351         "wimAccountId": {"oneOf": [id_schema, bool_schema, null_schema]},
 352         "placement-engine": string_schema,
 353         "placement-constraints": object_schema,
 354         "additionalParamsForNs": object_schema,
 355         "additionalParamsForVnf": additional_params_for_vnf,
 356         "config-units": integer1_schema,  # number of configuration units of this ns, by default 1
 357         "k8s-namespace": name_schema,
 358         "ssh_keys": {"type": "array", "items": {"type": "string"}},
 359         "timeout_ns_deploy": integer1_schema,
 360         "nsr_id": id_schema,
 361         "vduImage": name_schema,
 362         "vnf": {
 363             "type": "array",
 364             "minItems": 1,
 365             "items": {
 366                 "type": "object",
 367                 "properties": {
 368                     "member-vnf-index": name_schema,
 369                     "vimAccountId": id_schema,
 370                     "vdu": {
 371                         "type": "array",
 372                         "minItems": 1,
 373                         "items": ns_instantiate_vdu,
 374                     },
 375                     "internal-vld": {
 376                         "type": "array",
 377                         "minItems": 1,
 378                         "items": ns_instantiate_internal_vld,
 379                     },
 380                 },
 381                 "required": ["member-vnf-index"],
 382                 "minProperties": 2,
 383                 "additionalProperties": False,
 384             },
 385         },
 386         "vld": {
 387             "type": "array",
 388             "minItems": 1,
 389             "items": {
 390                 "type": "object",
 391                 "properties": {
 392                     "name": string_schema,
 393                     "vim-network-name": {"oneOf": [string_schema, object_schema]},
 394                     "vim-network-id": {"oneOf": [string_schema, object_schema]},
 395                     "ns-net": object_schema,
 396                     "wimAccountId": {"oneOf": [id_schema, bool_schema, null_schema]},
 397                     "ip-profile": object_schema,
 398                     "provider-network": provider_network_schema,
 399                     "vnfd-connection-point-ref": {
 400                         "type": "array",
 401                         "minItems": 1,
 402                         "items": {
 403                             "type": "object",
 404                             "properties": {
 405                                 "member-vnf-index-ref": name_schema,
 406                                 "vnfd-connection-point-ref": name_schema,
 407                                 "ip-address": {"oneOf": [ip_schema, ipv6_schema]},
 408                                 # "mac-address": mac_schema,
 409                             },
 410                             "required": [
 411                                 "member-vnf-index-ref",
 412                                 "vnfd-connection-point-ref",
 413                             ],
 414                             "minProperties": 3,
 415                             "additionalProperties": False,
 416                         },
 417                     },
 418                 },
 419                 "required": ["name"],
 420                 "additionalProperties": False,
 421             },
 422         },
 423     },
 424     "required": ["nsName", "nsdId", "vimAccountId"],
 425     "additionalProperties": False,
 426 }
 427
 428 ns_terminate = {
 429     "title": "ns terminate input schema",
 430     "$schema": "http://json-schema.org/draft-04/schema#",
 431     "type": "object",
 432     "properties": {
 433         "lcmOperationType": string_schema,
 434         "nsInstanceId": id_schema,
 435         "autoremove": bool_schema,
 436         "timeout_ns_terminate": integer1_schema,
 437         "skip_terminate_primitives": bool_schema,
 438         "netsliceInstanceId": id_schema,
 439     },
 440     "additionalProperties": False,
 441 }
 442
 443 ns_update = {
 444     "title": "ns update input schema",
 445     "$schema": "http://json-schema.org/draft-04/schema#",
 446     "type": "object",
 447     "properties": {
 448         "lcmOperationType": string_schema,
 449         "nsInstanceId": id_schema,
 450         "timeout_ns_update": integer1_schema,
 451         "updateType": {
 452             "enum": ["CHANGE_VNFPKG", "REMOVE_VNF", "MODIFY_VNF_INFORMATION"]
 453         },
 454         "modifyVnfInfoData": {
 455             "type": "object",
 456             "properties": {
 457                 "vnfInstanceId": id_schema,
 458                 "vnfdId": id_schema,
 459             },
 460             "required": ["vnfInstanceId", "vnfdId"],
 461         },
 462         "removeVnfInstanceId": id_schema,
 463         "changeVnfPackageData": {
 464             "type": "object",
 465             "properties": {
 466                 "vnfInstanceId": id_schema,
 467                 "vnfdId": id_schema,
 468             },
 469             "required": ["vnfInstanceId", "vnfdId"],
 470         },
 471     },
 472     "required": ["updateType"],
 473     "additionalProperties": False,
 474 }
 475
 476 ns_action = {  # TODO for the moment it is only contemplated the vnfd primitive execution
 477     "title": "ns action input schema",
 478     "$schema": "http://json-schema.org/draft-04/schema#",
 479     "type": "object",
 480     "properties": {
 481         "lcmOperationType": string_schema,
 482         "nsInstanceId": id_schema,
 483         "member_vnf_index": name_schema,
 484         "vnf_member_index": name_schema,  # TODO for backward compatibility. To remove in future
 485         "vdu_id": name_schema,
 486         "vdu_count_index": integer0_schema,
 487         "kdu_name": name_schema,
 488         "primitive": name_schema,
 489         "timeout_ns_action": integer1_schema,
 490         "primitive_params": {"type": "object"},
 491     },
 492     "required": ["primitive", "primitive_params"],  # TODO add member_vnf_index
 493     "additionalProperties": False,
 494 }
 495 ns_scale = {  # TODO for the moment it is only VDU-scaling
 496     "title": "ns scale input schema",
 497     "$schema": "http://json-schema.org/draft-04/schema#",
 498     "type": "object",
 499     "properties": {
 500         "lcmOperationType": string_schema,
 501         "nsInstanceId": id_schema,
 502         "scaleType": {"enum": ["SCALE_VNF"]},
 503         "timeout_ns_scale": integer1_schema,
 504         "scaleVnfData": {
 505             "type": "object",
 506             "properties": {
 507                 "vnfInstanceId": name_schema,
 508                 "scaleVnfType": {"enum": ["SCALE_OUT", "SCALE_IN"]},
 509                 "scaleByStepData": {
 510                     "type": "object",
 511                     "properties": {
 512                         "scaling-group-descriptor": name_schema,
 513                         "member-vnf-index": name_schema,
 514                         "scaling-policy": name_schema,
 515                     },
 516                     "required": ["scaling-group-descriptor", "member-vnf-index"],
 517                     "additionalProperties": False,
 518                 },
 519             },
 520             "required": ["scaleVnfType", "scaleByStepData"],  # vnfInstanceId
 521             "additionalProperties": False,
 522         },
 523         "scaleTime": time_schema,
 524     },
 525     "required": ["scaleType", "scaleVnfData"],
 526     "additionalProperties": False,
 527 }
 528
 529 ns_migrate = {
 530     "title": "ns migrate input schema",
 531     "$schema": "http://json-schema.org/draft-04/schema#",
 532     "type": "object",
 533     "properties": {
 534         "lcmOperationType": string_schema,
 535         "nsInstanceId": id_schema,
 536         "vnfInstanceId": id_schema,
 537         "migrateToHost": string_schema,
 538         "vdu": {
 539             "type": "object",
 540                 "properties": {
 541                     "vduId": name_schema,
 542                     "vduCountIndex": integer0_schema,
 543                 },
 544                 "required": ["vduId"],
 545                 "additionalProperties": False,
 546         },
 547     },
 548     "required": ["vnfInstanceId"],
 549     "additionalProperties": False
 550 }
 551
 552 schema_version = {"type": "string", "enum": ["1.0"]}
 553 schema_type = {"type": "string"}
 554 vim_type = shortname_schema  # {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
 555
 556 vim_account_edit_schema = {
 557     "title": "vim_account edit input schema",
 558     "$schema": "http://json-schema.org/draft-04/schema#",
 559     "type": "object",
 560     "properties": {
 561         "name": name_schema,
 562         "description": description_schema,
 563         "vim": name_schema,
 564         "datacenter": name_schema,
 565         "vim_type": vim_type,
 566         "vim_url": description_schema,
 567         # "vim_url_admin": description_schema,
 568         # "vim_tenant": name_schema,
 569         "vim_tenant_name": name_schema,
 570         "vim_user": string_schema,
 571         "vim_password": passwd_schema,
 572         "vca": id_schema,
 573         "config": {"type": "object"},
 574         "prometheus-config": {"type": "object"},
 575     },
 576     "additionalProperties": False,
 577 }
 578
 579 vim_account_new_schema = {
 580     "title": "vim_account creation input schema",
 581     "$schema": "http://json-schema.org/draft-04/schema#",
 582     "type": "object",
 583     "properties": {
 584         "schema_version": schema_version,
 585         "schema_type": schema_type,
 586         "name": name_schema,
 587         "description": description_schema,
 588         "vim": name_schema,
 589         "datacenter": name_schema,
 590         "vim_type": vim_type,
 591         "vim_url": description_schema,
 592         # "vim_url_admin": description_schema,
 593         # "vim_tenant": name_schema,
 594         "vim_tenant_name": name_schema,
 595         "vim_user": string_schema,
 596         "vim_password": passwd_schema,
 597         "vca": id_schema,
 598         "config": {"type": "object"},
 599         "prometheus-config": {"type": "object"},
 600     },
 601     "required": [
 602         "name",
 603         "vim_url",
 604         "vim_type",
 605         "vim_user",
 606         "vim_password",
 607         "vim_tenant_name",
 608     ],
 609     "additionalProperties": False,
 610 }
 611
 612 wim_type = shortname_schema  # {"enum": ["ietfl2vpn", "onos", "odl", "dynpac", "fake"]}
 613
 614 wim_account_edit_schema = {
 615     "title": "wim_account edit input schema",
 616     "$schema": "http://json-schema.org/draft-04/schema#",
 617     "type": "object",
 618     "properties": {
 619         "name": name_schema,
 620         "description": description_schema,
 621         "wim": name_schema,
 622         "wim_type": wim_type,
 623         "wim_url": description_schema,
 624         "user": string_schema,
 625         "password": passwd_schema,
 626         "config": {"type": "object"},
 627     },
 628     "additionalProperties": False,
 629 }
 630
 631 wim_account_new_schema = {
 632     "title": "wim_account creation input schema",
 633     "$schema": "http://json-schema.org/draft-04/schema#",
 634     "type": "object",
 635     "properties": {
 636         "schema_version": schema_version,
 637         "schema_type": schema_type,
 638         "name": name_schema,
 639         "description": description_schema,
 640         "wim": name_schema,
 641         "wim_type": wim_type,
 642         "wim_url": description_schema,
 643         "user": string_schema,
 644         "password": passwd_schema,
 645         "config": {
 646             "type": "object",
 647             "patternProperties": {".": {"not": {"type": "null"}}},
 648         },
 649     },
 650     "required": ["name", "wim_url", "wim_type"],
 651     "additionalProperties": False,
 652 }
 653
 654 sdn_properties = {
 655     "name": name_schema,
 656     "type": {"type": "string"},
 657     "url": {"type": "string"},
 658     "user": string_schema,
 659     "password": passwd_schema,
 660     "config": {"type": "object"},
 661     "description": description_schema,
 662     # The folowing are deprecated. Maintanied for backward compatibility
 663     "dpid": dpid_Schema,
 664     "ip": ip_schema,
 665     "port": port_schema,
 666     "version": {"type": "string", "minLength": 1, "maxLength": 12},
 667 }
 668 sdn_new_schema = {
 669     "title": "sdn controller information schema",
 670     "$schema": "http://json-schema.org/draft-04/schema#",
 671     "type": "object",
 672     "properties": sdn_properties,
 673     "required": ["name", "type"],
 674     "additionalProperties": False,
 675 }
 676 sdn_edit_schema = {
 677     "title": "sdn controller update information schema",
 678     "$schema": "http://json-schema.org/draft-04/schema#",
 679     "type": "object",
 680     "properties": sdn_properties,
 681     # "required": ["name", "port", 'ip', 'dpid', 'type'],
 682     "additionalProperties": False,
 683 }
 684 sdn_port_mapping_schema = {
 685     "$schema": "http://json-schema.org/draft-04/schema#",
 686     "title": "sdn port mapping information schema",
 687     "type": "array",
 688     "items": {
 689         "type": "object",
 690         "properties": {
 691             "compute_node": shortname_schema,
 692             "ports": {
 693                 "type": "array",
 694                 "items": {
 695                     "type": "object",
 696                     "properties": {
 697                         "pci": pci_extended_schema,
 698                         "switch_port": shortname_schema,
 699                         "switch_mac": mac_schema,
 700                     },
 701                     "required": ["pci"],
 702                 },
 703             },
 704         },
 705         "required": ["compute_node", "ports"],
 706     },
 707 }
 708 sdn_external_port_schema = {
 709     "$schema": "http://json-schema.org/draft-04/schema#",
 710     "title": "External port information",
 711     "type": "object",
 712     "properties": {
 713         "port": {"type": "string", "minLength": 1, "maxLength": 60},
 714         "vlan": vlan_schema,
 715         "mac": mac_schema,
 716     },
 717     "required": ["port"],
 718 }
 719
 720 # K8s Clusters
 721 k8scluster_deploy_method_schema = {
 722     "$schema": "http://json-schema.org/draft-04/schema#",
 723     "title": "Deployment methods for K8s cluster",
 724     "type": "object",
 725     "properties": {
 726         "helm-chart": {"type": "boolean"},
 727         "juju-bundle": {"type": "boolean"},
 728         "helm-chart-v3": {"type": "boolean"},
 729     },
 730     "additionalProperties": False,
 731     "minProperties": 3,
 732 }
 733 k8scluster_nets_schema = {
 734     "title": "k8scluster nets input schema",
 735     "$schema": "http://json-schema.org/draft-04/schema#",
 736     "type": "object",
 737     "patternProperties": {".": {"oneOf": [name_schema, null_schema]}},
 738     "minProperties": 1,
 739     "additionalProperties": False,
 740 }
 741 k8scluster_new_schema = {
 742     "title": "k8scluster creation input schema",
 743     "$schema": "http://json-schema.org/draft-04/schema#",
 744     "type": "object",
 745     "properties": {
 746         "schema_version": schema_version,
 747         "schema_type": schema_type,
 748         "name": name_schema,
 749         "description": description_schema,
 750         "credentials": object_schema,
 751         "vim_account": id_schema,
 752         "vca_id": id_schema,
 753         "k8s_version": string_schema,
 754         "nets": k8scluster_nets_schema,
 755         "deployment_methods": k8scluster_deploy_method_schema,
 756         "namespace": name_schema,
 757         "cni": nameshort_list_schema,
 758     },
 759     "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
 760     "additionalProperties": False,
 761 }
 762 k8scluster_edit_schema = {
 763     "title": "vim_account edit input schema",
 764     "$schema": "http://json-schema.org/draft-04/schema#",
 765     "type": "object",
 766     "properties": {
 767         "name": name_schema,
 768         "description": description_schema,
 769         "credentials": object_schema,
 770         "vim_account": id_schema,
 771         "vca_id": id_schema,
 772         "k8s_version": string_schema,
 773         "nets": k8scluster_nets_schema,
 774         "namespace": name_schema,
 775         "cni": nameshort_list_schema,
 776     },
 777     "additionalProperties": False,
 778 }
 779
 780 # VCA
 781 vca_new_schema = {
 782     "title": "vca creation input schema",
 783     "$schema": "http://json-schema.org/draft-04/schema#",
 784     "type": "object",
 785     "properties": {
 786         "schema_version": schema_version,
 787         "schema_type": schema_type,
 788         "name": name_schema,
 789         "description": description_schema,
 790         "endpoints": description_list_schema,
 791         "user": string_schema,
 792         "secret": passwd_schema,
 793         "cacert": long_description_schema,
 794         "lxd-cloud": shortname_schema,
 795         "lxd-credentials": shortname_schema,
 796         "k8s-cloud": shortname_schema,
 797         "k8s-credentials": shortname_schema,
 798         "model-config": object_schema,
 799     },
 800     "required": [
 801         "name",
 802         "endpoints",
 803         "user",
 804         "secret",
 805         "cacert",
 806         "lxd-cloud",
 807         "lxd-credentials",
 808         "k8s-cloud",
 809         "k8s-credentials",
 810     ],
 811     "additionalProperties": False,
 812 }
 813 vca_edit_schema = {
 814     "title": "vca creation input schema",
 815     "$schema": "http://json-schema.org/draft-04/schema#",
 816     "type": "object",
 817     "properties": {
 818         "name": name_schema,
 819         "description": description_schema,
 820         "endpoints": description_list_schema,
 821         "port": integer1_schema,
 822         "user": string_schema,
 823         "secret": passwd_schema,
 824         "cacert": long_description_schema,
 825         "lxd-cloud": shortname_schema,
 826         "lxd-credentials": shortname_schema,
 827         "k8s-cloud": shortname_schema,
 828         "k8s-credentials": shortname_schema,
 829         "model-config": object_schema,
 830     },
 831     "additionalProperties": False,
 832 }
 833
 834 # K8s Repos
 835 k8srepo_types = {"enum": ["helm-chart", "juju-bundle"]}
 836 k8srepo_properties = {
 837     "name": name_schema,
 838     "description": description_schema,
 839     "type": k8srepo_types,
 840     "url": description_schema,
 841 }
 842 k8srepo_new_schema = {
 843     "title": "k8scluster creation input schema",
 844     "$schema": "http://json-schema.org/draft-04/schema#",
 845     "type": "object",
 846     "properties": k8srepo_properties,
 847     "required": ["name", "type", "url"],
 848     "additionalProperties": False,
 849 }
 850 k8srepo_edit_schema = {
 851     "title": "vim_account edit input schema",
 852     "$schema": "http://json-schema.org/draft-04/schema#",
 853     "type": "object",
 854     "properties": k8srepo_properties,
 855     "additionalProperties": False,
 856 }
 857
 858 # OSM Repos
 859 osmrepo_types = {"enum": ["osm"]}
 860 osmrepo_properties = {
 861     "name": name_schema,
 862     "description": description_schema,
 863     "type": osmrepo_types,
 864     "url": description_schema
 865     # "user": string_schema,
 866     # "password": passwd_schema
 867 }
 868 osmrepo_new_schema = {
 869     "title": "osm repo creation input schema",
 870     "$schema": "http://json-schema.org/draft-04/schema#",
 871     "type": "object",
 872     "properties": osmrepo_properties,
 873     "required": ["name", "type", "url"],
 874     "additionalProperties": False,
 875 }
 876 osmrepo_edit_schema = {
 877     "title": "osm repo edit input schema",
 878     "$schema": "http://json-schema.org/draft-04/schema#",
 879     "type": "object",
 880     "properties": osmrepo_properties,
 881     "additionalProperties": False,
 882 }
 883
 884 # PDUs
 885 pdu_interface = {
 886     "type": "object",
 887     "properties": {
 888         "name": shortname_schema,
 889         "mgmt": bool_schema,
 890         "type": {"enum": ["overlay", "underlay"]},
 891         "ip-address": {"oneOf": [ip_schema, ipv6_schema]},
 892         # TODO, add user, password, ssh-key
 893         "mac-address": mac_schema,
 894         "vim-network-name": shortname_schema,  # interface is connected to one vim network, or switch port
 895         "vim-network-id": shortname_schema,
 896         # # provide this in case SDN assist must deal with this interface
 897         # "switch-dpid": dpid_Schema,
 898         # "switch-port": shortname_schema,
 899         # "switch-mac": shortname_schema,
 900         # "switch-vlan": vlan_schema,
 901     },
 902     "required": ["name", "mgmt", "ip-address"],
 903     "additionalProperties": False,
 904 }
 905 pdu_new_schema = {
 906     "title": "pdu creation input schema",
 907     "$schema": "http://json-schema.org/draft-04/schema#",
 908     "type": "object",
 909     "properties": {
 910         "name": shortname_schema,
 911         "type": shortname_schema,
 912         "description": description_schema,
 913         "shared": bool_schema,
 914         "vims": nameshort_list_schema,
 915         "vim_accounts": nameshort_list_schema,
 916         "interfaces": {"type": "array", "items": pdu_interface, "minItems": 1},
 917     },
 918     "required": ["name", "type", "interfaces"],
 919     "additionalProperties": False,
 920 }
 921 pdu_edit_schema = {
 922     "title": "pdu edit input schema",
 923     "$schema": "http://json-schema.org/draft-04/schema#",
 924     "type": "object",
 925     "properties": {
 926         "name": shortname_schema,
 927         "type": shortname_schema,
 928         "description": description_schema,
 929         "shared": bool_schema,
 930         "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]},
 931         "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]},
 932         "interfaces": {
 933             "oneOf": [
 934                 array_edition_schema,
 935                 {"type": "array", "items": pdu_interface, "minItems": 1},
 936             ]
 937         },
 938     },
 939     "additionalProperties": False,
 940     "minProperties": 1,
 941 }
 942
 943 # VNF PKG OPERATIONS
 944 vnfpkgop_new_schema = {
 945     "title": "VNF PKG operation creation input schema",
 946     "$schema": "http://json-schema.org/draft-04/schema#",
 947     "type": "object",
 948     "properties": {
 949         "lcmOperationType": string_schema,
 950         "vnfPkgId": id_schema,
 951         "kdu_name": name_schema,
 952         "primitive": name_schema,
 953         "primitive_params": {"type": "object"},
 954     },
 955     "required": [
 956         "lcmOperationType",
 957         "vnfPkgId",
 958         "kdu_name",
 959         "primitive",
 960         "primitive_params",
 961     ],
 962     "additionalProperties": False,
 963 }
 964
 965 # USERS
 966 project_role_mappings = {
 967     "title": "list pf projects/roles",
 968     "$schema": "http://json-schema.org/draft-04/schema#",
 969     "type": "array",
 970     "items": {
 971         "type": "object",
 972         "properties": {"project": shortname_schema, "role": shortname_schema},
 973         "required": ["project", "role"],
 974         "additionalProperties": False,
 975     },
 976     "minItems": 1,
 977 }
 978 project_role_mappings_optional = {
 979     "title": "list of projects/roles or projects only",
 980     "$schema": "http://json-schema.org/draft-04/schema#",
 981     "type": "array",
 982     "items": {
 983         "type": "object",
 984         "properties": {"project": shortname_schema, "role": shortname_schema},
 985         "required": ["project"],
 986         "additionalProperties": False,
 987     },
 988     "minItems": 1,
 989 }
 990 user_new_schema = {
 991     "$schema": "http://json-schema.org/draft-04/schema#",
 992     "title": "New user schema",
 993     "type": "object",
 994     "properties": {
 995         "username": string_schema,
 996         "domain_name": shortname_schema,
 997         "password": passwd_schema,
 998         "projects": nameshort_list_schema,
 999         "project_role_mappings": project_role_mappings,
1000     },
1001     "required": ["username", "password"],
1002     "additionalProperties": False,
1003 }
1004 user_edit_schema = {
1005     "$schema": "http://json-schema.org/draft-04/schema#",
1006     "title": "User edit schema for administrators",
1007     "type": "object",
1008     "properties": {
1009         "password": passwd_schema,
1010         "old_password": passwd_schema,
1011         "username": string_schema,  # To allow User Name modification
1012         "projects": {"oneOf": [nameshort_list_schema, array_edition_schema]},
1013         "project_role_mappings": project_role_mappings,
1014         "add_project_role_mappings": project_role_mappings,
1015         "remove_project_role_mappings": project_role_mappings_optional,
1016     },
1017     "minProperties": 1,
1018     "additionalProperties": False,
1019 }
1020
1021 # PROJECTS
1022 topics_with_quota = [
1023     "vnfds",
1024     "nsds",
1025     "slice_templates",
1026     "pduds",
1027     "ns_instances",
1028     "slice_instances",
1029     "vim_accounts",
1030     "wim_accounts",
1031     "sdn_controllers",
1032     "k8sclusters",
1033     "vca",
1034     "k8srepos",
1035     "osmrepos",
1036     "ns_subscriptions",
1037 ]
1038 project_new_schema = {
1039     "$schema": "http://json-schema.org/draft-04/schema#",
1040     "title": "New project schema for administrators",
1041     "type": "object",
1042     "properties": {
1043         "name": shortname_schema,
1044         "admin": bool_schema,
1045         "domain_name": shortname_schema,
1046         "quotas": {
1047             "type": "object",
1048             "properties": {topic: integer0_schema for topic in topics_with_quota},
1049             "additionalProperties": False,
1050         },
1051     },
1052     "required": ["name"],
1053     "additionalProperties": False,
1054 }
1055 project_edit_schema = {
1056     "$schema": "http://json-schema.org/draft-04/schema#",
1057     "title": "Project edit schema for administrators",
1058     "type": "object",
1059     "properties": {
1060         "admin": bool_schema,
1061         "name": shortname_schema,  # To allow Project Name modification
1062         "quotas": {
1063             "type": "object",
1064             "properties": {
1065                 topic: {"oneOf": [integer0_schema, null_schema]}
1066                 for topic in topics_with_quota
1067             },
1068             "additionalProperties": False,
1069         },
1070     },
1071     "additionalProperties": False,
1072     "minProperties": 1,
1073 }
1074
1075 # ROLES
1076 roles_new_schema = {
1077     "$schema": "http://json-schema.org/draft-04/schema#",
1078     "title": "New role schema for administrators",
1079     "type": "object",
1080     "properties": {
1081         "name": shortname_schema,
1082         "permissions": {
1083             "type": "object",
1084             "patternProperties": {
1085                 ".": bool_schema,
1086             },
1087             # "minProperties": 1,
1088         },
1089     },
1090     "required": ["name"],
1091     "additionalProperties": False,
1092 }
1093 roles_edit_schema = {
1094     "$schema": "http://json-schema.org/draft-04/schema#",
1095     "title": "Roles edit schema for administrators",
1096     "type": "object",
1097     "properties": {
1098         "name": shortname_schema,
1099         "permissions": {
1100             "type": "object",
1101             "patternProperties": {".": {"oneOf": [bool_schema, null_schema]}},
1102             # "minProperties": 1,
1103         },
1104     },
1105     "additionalProperties": False,
1106     "minProperties": 1,
1107 }
1108
1109 # GLOBAL SCHEMAS
1110
1111 nbi_new_input_schemas = {
1112     "users": user_new_schema,
1113     "projects": project_new_schema,
1114     "vim_accounts": vim_account_new_schema,
1115     "sdns": sdn_new_schema,
1116     "ns_instantiate": ns_instantiate,
1117     "ns_action": ns_action,
1118     "ns_scale": ns_scale,
1119     "ns_update": ns_update,
1120     "pdus": pdu_new_schema,
1121 }
1122
1123 nbi_edit_input_schemas = {
1124     "users": user_edit_schema,
1125     "projects": project_edit_schema,
1126     "vim_accounts": vim_account_edit_schema,
1127     "sdns": sdn_edit_schema,
1128     "pdus": pdu_edit_schema,
1129 }
1130
1131 # NETSLICE SCHEMAS
1132 nsi_subnet_instantiate = deepcopy(ns_instantiate)
1133 nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema"
1134 nsi_subnet_instantiate["properties"]["id"] = name_schema
1135 del nsi_subnet_instantiate["required"]
1136
1137 nsi_vld_instantiate = {
1138     "title": "netslice vld instantiation params input schema",
1139     "$schema": "http://json-schema.org/draft-04/schema#",
1140     "type": "object",
1141     "properties": {
1142         "name": string_schema,
1143         "vim-network-name": {"oneOf": [string_schema, object_schema]},
1144         "vim-network-id": {"oneOf": [string_schema, object_schema]},
1145         "ip-profile": object_schema,
1146     },
1147     "required": ["name"],
1148     "additionalProperties": False,
1149 }
1150
1151 nsi_instantiate = {
1152     "title": "netslice action instantiate input schema",
1153     "$schema": "http://json-schema.org/draft-04/schema#",
1154     "type": "object",
1155     "properties": {
1156         "lcmOperationType": string_schema,
1157         "netsliceInstanceId": id_schema,
1158         "nsiName": name_schema,
1159         "nsiDescription": {"oneOf": [description_schema, null_schema]},
1160         "nstId": string_schema,
1161         "vimAccountId": id_schema,
1162         "timeout_nsi_deploy": integer1_schema,
1163         "ssh_keys": {"type": "array", "items": {"type": "string"}},
1164         "nsi_id": id_schema,
1165         "additionalParamsForNsi": object_schema,
1166         "netslice-subnet": {
1167             "type": "array",
1168             "minItems": 1,
1169             "items": nsi_subnet_instantiate,
1170         },
1171         "netslice-vld": {"type": "array", "minItems": 1, "items": nsi_vld_instantiate},
1172     },
1173     "required": ["nsiName", "nstId", "vimAccountId"],
1174     "additionalProperties": False,
1175 }
1176
1177 nsi_action = {}
1178
1179 nsi_terminate = {}
1180
1181 nsinstancesubscriptionfilter_schema = {
1182     "title": "instance identifier schema",
1183     "$schema": "http://json-schema.org/draft-07/schema#",
1184     "type": "object",
1185     "properties": {
1186         "nsdIds": {"type": "array"},
1187         "vnfdIds": {"type": "array"},
1188         "pnfdIds": {"type": "array"},
1189         "nsInstanceIds": {"type": "array"},
1190         "nsInstanceNames": {"type": "array"},
1191     },
1192 }
1193
1194 nslcmsub_schema = {
1195     "title": "nslcmsubscription input schema",
1196     "$schema": "http://json-schema.org/draft-07/schema#",
1197     "type": "object",
1198     "properties": {
1199         "nsInstanceSubscriptionFilter": nsinstancesubscriptionfilter_schema,
1200         "notificationTypes": {
1201             "type": "array",
1202             "items": {
1203                 "enum": [
1204                     "NsLcmOperationOccurrenceNotification",
1205                     "NsChangeNotification",
1206                     "NsIdentifierCreationNotification",
1207                     "NsIdentifierDeletionNotification",
1208                 ]
1209             },
1210         },
1211         "operationTypes": {
1212             "type": "array",
1213             "items": {"enum": ["INSTANTIATE", "SCALE", "TERMINATE", "UPDATE", "HEAL"]},
1214         },
1215         "operationStates": {
1216             "type": "array",
1217             "items": {
1218                 "enum": [
1219                     "PROCESSING",
1220                     "COMPLETED",
1221                     "PARTIALLY_COMPLETED",
1222                     "FAILED",
1223                     "FAILED_TEMP",
1224                     "ROLLING_BACK",
1225                     "ROLLED_BACK",
1226                 ]
1227             },
1228         },
1229         "nsComponentTypes": {"type": "array", "items": {"enum": ["VNF", "NS", "PNF"]}},
1230         "lcmOpNameImpactingNsComponent": {
1231             "type": "array",
1232             "items": {
1233                 "enum": [
1234                     "VNF_INSTANTIATE",
1235                     "VNF_SCALE",
1236                     "VNF_SCALE_TO_LEVEL",
1237                     "VNF_CHANGE_FLAVOUR",
1238                     "VNF_TERMINATE",
1239                     "VNF_HEAL",
1240                     "VNF_OPERATE",
1241                     "VNF_CHANGE_EXT_CONN",
1242                     "VNF_MODIFY_INFO",
1243                     "NS_INSTANTIATE",
1244                     "NS_SCALE",
1245                     "NS_UPDATE",
1246                     "NS_TERMINATE",
1247                     "NS_HEAL",
1248                 ]
1249             },
1250         },
1251         "lcmOpOccStatusImpactingNsComponent": {
1252             "type": "array",
1253             "items": {
1254                 "enum": [
1255                     "START",
1256                     "COMPLETED",
1257                     "PARTIALLY_COMPLETED",
1258                     "FAILED",
1259                     "ROLLED_BACK",
1260                 ]
1261             },
1262         },
1263     },
1264     "allOf": [
1265         {
1266             "if": {
1267                 "properties": {
1268                     "notificationTypes": {
1269                         "contains": {"const": "NsLcmOperationOccurrenceNotification"}
1270                     }
1271                 },
1272             },
1273             "then": {
1274                 "anyOf": [
1275                     {"required": ["operationTypes"]},
1276                     {"required": ["operationStates"]},
1277                 ]
1278             },
1279         },
1280         {
1281             "if": {
1282                 "properties": {
1283                     "notificationTypes": {"contains": {"const": "NsChangeNotification"}}
1284                 },
1285             },
1286             "then": {
1287                 "anyOf": [
1288                     {"required": ["nsComponentTypes"]},
1289                     {"required": ["lcmOpNameImpactingNsComponent"]},
1290                     {"required": ["lcmOpOccStatusImpactingNsComponent"]},
1291                 ]
1292             },
1293         },
1294     ],
1295 }
1296
1297 authentication_schema = {
1298     "title": "authentication schema for subscription",
1299     "$schema": "http://json-schema.org/draft-07/schema#",
1300     "type": "object",
1301     "properties": {
1302         "authType": {"enum": ["basic"]},
1303         "paramsBasic": {
1304             "type": "object",
1305             "properties": {
1306                 "userName": string_schema,
1307                 "password": passwd_schema,
1308             },
1309         },
1310     },
1311 }
1312
1313 subscription = {
1314     "title": "subscription input schema",
1315     "$schema": "http://json-schema.org/draft-07/schema#",
1316     "type": "object",
1317     "properties": {
1318         "filter": nslcmsub_schema,
1319         "CallbackUri": description_schema,
1320         "authentication": authentication_schema,
1321     },
1322     "required": ["CallbackUri"],
1323 }
1324
1325 vnflcmsub_schema = {
1326     "title": "vnflcmsubscription input schema",
1327     "$schema": "http://json-schema.org/draft-07/schema#",
1328     "type": "object",
1329     "properties": {
1330         "VnfInstanceSubscriptionFilter": {
1331             "type": "object",
1332             "properties": {
1333                 "vnfdIds": {"type": "array"},
1334                 "vnfInstanceIds": {"type": "array"},
1335             },
1336         },
1337         "notificationTypes": {
1338             "type": "array",
1339             "items": {
1340                 "enum": [
1341                     "VnfIdentifierCreationNotification",
1342                     "VnfLcmOperationOccurrenceNotification",
1343                     "VnfIdentifierDeletionNotification"
1344                     ]
1345             }
1346         },
1347         "operationTypes": {
1348             "type": "array",
1349             "items": {
1350                 "enum": [
1351                     "INSTANTIATE", "SCALE", "SCALE_TO_LEVEL", "CHANGE_FLAVOUR", "TERMINATE",
1352                     "HEAL", "OPERATE", "CHANGE_EXT_CONN", "MODIFY_INFO", "CREATE_SNAPSHOT",
1353                     "REVERT_TO_SNAPSHOT", "CHANGE_VNFPKG"
1354                     ]
1355             }
1356         },
1357         "operationStates": {
1358             "type": "array",
1359             "items": {
1360                 "enum": [
1361                     "STARTING", "PROCESSING", "COMPLETED", "FAILED_TEMP", "FAILED",
1362                     "ROLLING_BACK", "ROLLED_BACK"
1363                     ]
1364             }
1365         }
1366     },
1367     "required": ["VnfInstanceSubscriptionFilter", "notificationTypes"]
1368  }
1369
1370 vnf_subscription = {
1371     "title": "vnf subscription input schema",
1372     "$schema": "http://json-schema.org/draft-07/schema#",
1373     "type": "object",
1374     "properties": {
1375         "filter": vnflcmsub_schema,
1376         "CallbackUri": description_schema,
1377         "authentication": authentication_schema
1378     },
1379     "required": ["filter", "CallbackUri"]
1380 }
1381
1382
1383 class ValidationError(Exception):
1384     def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY):
1385         self.http_code = http_code
1386         Exception.__init__(self, message)
1387
1388
1389 def validate_input(indata, schema_to_use):
1390     """
1391     Validates input data against json schema
1392     :param indata: user input data. Should be a dictionary
1393     :param schema_to_use: jsonschema to test
1394     :return: None if ok, raises ValidationError exception on error
1395     """
1396     try:
1397         if schema_to_use:
1398             js_v(indata, schema_to_use)
1399         return None
1400     except js_e.ValidationError as e:
1401         if e.path:
1402             error_pos = "at '" + ":".join(map(str, e.path)) + "'"
1403         else:
1404             error_pos = ""
1405         raise ValidationError("Format error {} '{}' ".format(error_pos, e.message))
1406     except js_e.SchemaError:
1407         raise ValidationError(
1408             "Bad json schema {}".format(schema_to_use),
1409             http_code=HTTPStatus.INTERNAL_SERVER_ERROR,
1410         )
1411
1412
1413 def is_valid_uuid(x):
1414     """
1415     Test for a valid UUID
1416     :param x: string to test
1417     :return: True if x is a valid uuid, False otherwise
1418     """
1419     try:
1420         if UUID(x):
1421             return True
1422     except (TypeError, ValueError, AttributeError):
1423         return False