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", "OPERATE_VNF"]
 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         "operateVnfData": {
 472             "type": "object",
 473             "properties": {
 474                 "vnfInstanceId": id_schema,
 475                 "changeStateTo": name_schema,
 476                 "additionalParam": {
 477                     "type": "object",
 478                     "properties": {
 479                         "run-day1": bool_schema,
 480                         "vdu_id": name_schema,
 481                         "count-index": integer0_schema,
 482                     },
 483                     "required": ["vdu_id", "count-index"],
 484                     "additionalProperties": False,
 485                 }
 486             },
 487             "required": ["vnfInstanceId", "changeStateTo"],
 488         }
 489     },
 490     "required": ["updateType"],
 491     "additionalProperties": False,
 492 }
 493
 494 ns_action = {  # TODO for the moment it is only contemplated the vnfd primitive execution
 495     "title": "ns action input schema",
 496     "$schema": "http://json-schema.org/draft-04/schema#",
 497     "type": "object",
 498     "properties": {
 499         "lcmOperationType": string_schema,
 500         "nsInstanceId": id_schema,
 501         "member_vnf_index": name_schema,
 502         "vnf_member_index": name_schema,  # TODO for backward compatibility. To remove in future
 503         "vdu_id": name_schema,
 504         "vdu_count_index": integer0_schema,
 505         "kdu_name": name_schema,
 506         "primitive": name_schema,
 507         "timeout_ns_action": integer1_schema,
 508         "primitive_params": {"type": "object"},
 509     },
 510     "required": ["primitive", "primitive_params"],  # TODO add member_vnf_index
 511     "additionalProperties": False,
 512 }
 513
 514 ns_scale = {  # TODO for the moment it is only VDU-scaling
 515     "title": "ns scale input schema",
 516     "$schema": "http://json-schema.org/draft-04/schema#",
 517     "type": "object",
 518     "properties": {
 519         "lcmOperationType": string_schema,
 520         "nsInstanceId": id_schema,
 521         "scaleType": {"enum": ["SCALE_VNF"]},
 522         "timeout_ns_scale": integer1_schema,
 523         "scaleVnfData": {
 524             "type": "object",
 525             "properties": {
 526                 "vnfInstanceId": name_schema,
 527                 "scaleVnfType": {"enum": ["SCALE_OUT", "SCALE_IN"]},
 528                 "scaleByStepData": {
 529                     "type": "object",
 530                     "properties": {
 531                         "scaling-group-descriptor": name_schema,
 532                         "member-vnf-index": name_schema,
 533                         "scaling-policy": name_schema,
 534                     },
 535                     "required": ["scaling-group-descriptor", "member-vnf-index"],
 536                     "additionalProperties": False,
 537                 },
 538             },
 539             "required": ["scaleVnfType", "scaleByStepData"],  # vnfInstanceId
 540             "additionalProperties": False,
 541         },
 542         "scaleTime": time_schema,
 543     },
 544     "required": ["scaleType", "scaleVnfData"],
 545     "additionalProperties": False,
 546 }
 547
 548 ns_migrate = {
 549     "title": "ns migrate input schema",
 550     "$schema": "http://json-schema.org/draft-04/schema#",
 551     "type": "object",
 552     "properties": {
 553         "lcmOperationType": string_schema,
 554         "nsInstanceId": id_schema,
 555         "vnfInstanceId": id_schema,
 556         "migrateToHost": string_schema,
 557         "vdu": {
 558             "type": "object",
 559                 "properties": {
 560                     "vduId": name_schema,
 561                     "vduCountIndex": integer0_schema,
 562                 },
 563                 "required": ["vduId"],
 564                 "additionalProperties": False,
 565         },
 566     },
 567     "required": ["vnfInstanceId"],
 568     "additionalProperties": False
 569 }
 570
 571 ns_heal = {
 572     "title": "ns heal input schema",
 573     "$schema": "http://json-schema.org/draft-04/schema#",
 574     "type": "object",
 575     "properties": {
 576         "lcmOperationType": string_schema,
 577         "nsInstanceId": id_schema,
 578         "timeout_ns_heal": integer1_schema,
 579         "healVnfData": {
 580             "type": "array",
 581             "items": {
 582                 "type": "object",
 583                 "properties": {
 584                     "vnfInstanceId": id_schema,
 585                     "cause": description_schema,
 586                     "additionalParams": {
 587                         "type": "object",
 588                         "properties": {
 589                             "run-day1": bool_schema,
 590                             "vdu": {
 591                                 "type": "array",
 592                                 "items": {
 593                                     "type": "object",
 594                                     "properties": {
 595                                         "run-day1": bool_schema,
 596                                         "vdu-id": name_schema,
 597                                         "count-index": integer0_schema,
 598                                     },
 599                                     "required": ["vdu-id"],
 600                                     "additionalProperties": False,
 601                                 },
 602                             },
 603                         },
 604                         "additionalProperties": False,
 605                     },
 606                 },
 607                 "required": ["vnfInstanceId"],
 608                 "additionalProperties": False,
 609             },
 610         },
 611     },
 612     "required": ["healVnfData"],
 613     "additionalProperties": False,
 614 }
 615
 616 ns_verticalscale = {
 617     "title": "vertial scale input schema",
 618     "$schema": "http://json-schema.org/draft-04/schema#",
 619     "type": "object",
 620     "properties": {
 621         "lcmOperationType": string_schema,
 622         "nsInstanceId": id_schema,
 623         "vnfInstanceId": id_schema,
 624         "migrateToHost": string_schema,
 625         "vdu": {
 626             "type": "object",
 627                 "properties": {
 628                     "vduId": name_schema,
 629                     "vduCountIndex": integer0_schema,
 630                 },
 631                 "required": ["vduId"],
 632                 "additionalProperties": False,
 633         },
 634     },
 635     "required": ["vnfInstanceId"],
 636     "additionalProperties": False
 637 }
 638
 639 schema_version = {"type": "string", "enum": ["1.0"]}
 640 schema_type = {"type": "string"}
 641 vim_type = shortname_schema  # {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
 642
 643 vim_account_edit_schema = {
 644     "title": "vim_account edit input schema",
 645     "$schema": "http://json-schema.org/draft-04/schema#",
 646     "type": "object",
 647     "properties": {
 648         "name": name_schema,
 649         "description": description_schema,
 650         "vim": name_schema,
 651         "datacenter": name_schema,
 652         "vim_type": vim_type,
 653         "vim_url": description_schema,
 654         # "vim_url_admin": description_schema,
 655         # "vim_tenant": name_schema,
 656         "vim_tenant_name": name_schema,
 657         "vim_user": string_schema,
 658         "vim_password": passwd_schema,
 659         "vca": id_schema,
 660         "config": {"type": "object"},
 661         "prometheus-config": {"type": "object"},
 662     },
 663     "additionalProperties": False,
 664 }
 665
 666 vim_account_new_schema = {
 667     "title": "vim_account creation input schema",
 668     "$schema": "http://json-schema.org/draft-04/schema#",
 669     "type": "object",
 670     "properties": {
 671         "schema_version": schema_version,
 672         "schema_type": schema_type,
 673         "name": name_schema,
 674         "description": description_schema,
 675         "vim": name_schema,
 676         "datacenter": name_schema,
 677         "vim_type": vim_type,
 678         "vim_url": description_schema,
 679         # "vim_url_admin": description_schema,
 680         # "vim_tenant": name_schema,
 681         "vim_tenant_name": name_schema,
 682         "vim_user": string_schema,
 683         "vim_password": passwd_schema,
 684         "vca": id_schema,
 685         "config": {"type": "object"},
 686         "prometheus-config": {"type": "object"},
 687     },
 688     "required": [
 689         "name",
 690         "vim_url",
 691         "vim_type",
 692         "vim_user",
 693         "vim_password",
 694         "vim_tenant_name",
 695     ],
 696     "additionalProperties": False,
 697 }
 698
 699 wim_type = shortname_schema  # {"enum": ["ietfl2vpn", "onos", "odl", "dynpac", "fake"]}
 700
 701 wim_account_edit_schema = {
 702     "title": "wim_account edit input schema",
 703     "$schema": "http://json-schema.org/draft-04/schema#",
 704     "type": "object",
 705     "properties": {
 706         "name": name_schema,
 707         "description": description_schema,
 708         "wim": name_schema,
 709         "wim_type": wim_type,
 710         "wim_url": description_schema,
 711         "user": string_schema,
 712         "password": passwd_schema,
 713         "config": {"type": "object"},
 714     },
 715     "additionalProperties": False,
 716 }
 717
 718 wim_account_new_schema = {
 719     "title": "wim_account creation input schema",
 720     "$schema": "http://json-schema.org/draft-04/schema#",
 721     "type": "object",
 722     "properties": {
 723         "schema_version": schema_version,
 724         "schema_type": schema_type,
 725         "name": name_schema,
 726         "description": description_schema,
 727         "wim": name_schema,
 728         "wim_type": wim_type,
 729         "wim_url": description_schema,
 730         "user": string_schema,
 731         "password": passwd_schema,
 732         "config": {
 733             "type": "object",
 734             "patternProperties": {".": {"not": {"type": "null"}}},
 735         },
 736     },
 737     "required": ["name", "wim_url", "wim_type"],
 738     "additionalProperties": False,
 739 }
 740
 741 sdn_properties = {
 742     "name": name_schema,
 743     "type": {"type": "string"},
 744     "url": {"type": "string"},
 745     "user": string_schema,
 746     "password": passwd_schema,
 747     "config": {"type": "object"},
 748     "description": description_schema,
 749     # The folowing are deprecated. Maintanied for backward compatibility
 750     "dpid": dpid_Schema,
 751     "ip": ip_schema,
 752     "port": port_schema,
 753     "version": {"type": "string", "minLength": 1, "maxLength": 12},
 754 }
 755 sdn_new_schema = {
 756     "title": "sdn controller information schema",
 757     "$schema": "http://json-schema.org/draft-04/schema#",
 758     "type": "object",
 759     "properties": sdn_properties,
 760     "required": ["name", "type"],
 761     "additionalProperties": False,
 762 }
 763 sdn_edit_schema = {
 764     "title": "sdn controller update information schema",
 765     "$schema": "http://json-schema.org/draft-04/schema#",
 766     "type": "object",
 767     "properties": sdn_properties,
 768     # "required": ["name", "port", 'ip', 'dpid', 'type'],
 769     "additionalProperties": False,
 770 }
 771 sdn_port_mapping_schema = {
 772     "$schema": "http://json-schema.org/draft-04/schema#",
 773     "title": "sdn port mapping information schema",
 774     "type": "array",
 775     "items": {
 776         "type": "object",
 777         "properties": {
 778             "compute_node": shortname_schema,
 779             "ports": {
 780                 "type": "array",
 781                 "items": {
 782                     "type": "object",
 783                     "properties": {
 784                         "pci": pci_extended_schema,
 785                         "switch_port": shortname_schema,
 786                         "switch_mac": mac_schema,
 787                     },
 788                     "required": ["pci"],
 789                 },
 790             },
 791         },
 792         "required": ["compute_node", "ports"],
 793     },
 794 }
 795 sdn_external_port_schema = {
 796     "$schema": "http://json-schema.org/draft-04/schema#",
 797     "title": "External port information",
 798     "type": "object",
 799     "properties": {
 800         "port": {"type": "string", "minLength": 1, "maxLength": 60},
 801         "vlan": vlan_schema,
 802         "mac": mac_schema,
 803     },
 804     "required": ["port"],
 805 }
 806
 807 # K8s Clusters
 808 k8scluster_deploy_method_schema = {
 809     "$schema": "http://json-schema.org/draft-04/schema#",
 810     "title": "Deployment methods for K8s cluster",
 811     "type": "object",
 812     "properties": {
 813         "helm-chart": {"type": "boolean"},
 814         "juju-bundle": {"type": "boolean"},
 815         "helm-chart-v3": {"type": "boolean"},
 816     },
 817     "additionalProperties": False,
 818     "minProperties": 3,
 819 }
 820 k8scluster_nets_schema = {
 821     "title": "k8scluster nets input schema",
 822     "$schema": "http://json-schema.org/draft-04/schema#",
 823     "type": "object",
 824     "patternProperties": {".": {"oneOf": [name_schema, null_schema]}},
 825     "minProperties": 1,
 826     "additionalProperties": False,
 827 }
 828 k8scluster_new_schema = {
 829     "title": "k8scluster creation input schema",
 830     "$schema": "http://json-schema.org/draft-04/schema#",
 831     "type": "object",
 832     "properties": {
 833         "schema_version": schema_version,
 834         "schema_type": schema_type,
 835         "name": name_schema,
 836         "description": description_schema,
 837         "credentials": object_schema,
 838         "vim_account": id_schema,
 839         "vca_id": id_schema,
 840         "k8s_version": string_schema,
 841         "nets": k8scluster_nets_schema,
 842         "deployment_methods": k8scluster_deploy_method_schema,
 843         "namespace": name_schema,
 844         "cni": nameshort_list_schema,
 845     },
 846     "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
 847     "additionalProperties": False,
 848 }
 849 k8scluster_edit_schema = {
 850     "title": "vim_account edit input schema",
 851     "$schema": "http://json-schema.org/draft-04/schema#",
 852     "type": "object",
 853     "properties": {
 854         "name": name_schema,
 855         "description": description_schema,
 856         "credentials": object_schema,
 857         "vim_account": id_schema,
 858         "vca_id": id_schema,
 859         "k8s_version": string_schema,
 860         "nets": k8scluster_nets_schema,
 861         "namespace": name_schema,
 862         "cni": nameshort_list_schema,
 863     },
 864     "additionalProperties": False,
 865 }
 866
 867 # VCA
 868 vca_new_schema = {
 869     "title": "vca creation input schema",
 870     "$schema": "http://json-schema.org/draft-04/schema#",
 871     "type": "object",
 872     "properties": {
 873         "schema_version": schema_version,
 874         "schema_type": schema_type,
 875         "name": name_schema,
 876         "description": description_schema,
 877         "endpoints": description_list_schema,
 878         "user": string_schema,
 879         "secret": passwd_schema,
 880         "cacert": long_description_schema,
 881         "lxd-cloud": shortname_schema,
 882         "lxd-credentials": shortname_schema,
 883         "k8s-cloud": shortname_schema,
 884         "k8s-credentials": shortname_schema,
 885         "model-config": object_schema,
 886     },
 887     "required": [
 888         "name",
 889         "endpoints",
 890         "user",
 891         "secret",
 892         "cacert",
 893         "lxd-cloud",
 894         "lxd-credentials",
 895         "k8s-cloud",
 896         "k8s-credentials",
 897     ],
 898     "additionalProperties": False,
 899 }
 900 vca_edit_schema = {
 901     "title": "vca creation input schema",
 902     "$schema": "http://json-schema.org/draft-04/schema#",
 903     "type": "object",
 904     "properties": {
 905         "name": name_schema,
 906         "description": description_schema,
 907         "endpoints": description_list_schema,
 908         "port": integer1_schema,
 909         "user": string_schema,
 910         "secret": passwd_schema,
 911         "cacert": long_description_schema,
 912         "lxd-cloud": shortname_schema,
 913         "lxd-credentials": shortname_schema,
 914         "k8s-cloud": shortname_schema,
 915         "k8s-credentials": shortname_schema,
 916         "model-config": object_schema,
 917     },
 918     "additionalProperties": False,
 919 }
 920
 921 # K8s Repos
 922 k8srepo_types = {"enum": ["helm-chart", "juju-bundle"]}
 923 k8srepo_properties = {
 924     "name": name_schema,
 925     "description": description_schema,
 926     "type": k8srepo_types,
 927     "url": description_schema,
 928 }
 929 k8srepo_new_schema = {
 930     "title": "k8scluster creation input schema",
 931     "$schema": "http://json-schema.org/draft-04/schema#",
 932     "type": "object",
 933     "properties": k8srepo_properties,
 934     "required": ["name", "type", "url"],
 935     "additionalProperties": False,
 936 }
 937 k8srepo_edit_schema = {
 938     "title": "vim_account edit input schema",
 939     "$schema": "http://json-schema.org/draft-04/schema#",
 940     "type": "object",
 941     "properties": k8srepo_properties,
 942     "additionalProperties": False,
 943 }
 944
 945 # OSM Repos
 946 osmrepo_types = {"enum": ["osm"]}
 947 osmrepo_properties = {
 948     "name": name_schema,
 949     "description": description_schema,
 950     "type": osmrepo_types,
 951     "url": description_schema
 952     # "user": string_schema,
 953     # "password": passwd_schema
 954 }
 955 osmrepo_new_schema = {
 956     "title": "osm repo creation input schema",
 957     "$schema": "http://json-schema.org/draft-04/schema#",
 958     "type": "object",
 959     "properties": osmrepo_properties,
 960     "required": ["name", "type", "url"],
 961     "additionalProperties": False,
 962 }
 963 osmrepo_edit_schema = {
 964     "title": "osm repo edit input schema",
 965     "$schema": "http://json-schema.org/draft-04/schema#",
 966     "type": "object",
 967     "properties": osmrepo_properties,
 968     "additionalProperties": False,
 969 }
 970
 971 # PDUs
 972 pdu_interface = {
 973     "type": "object",
 974     "properties": {
 975         "name": shortname_schema,
 976         "mgmt": bool_schema,
 977         "type": {"enum": ["overlay", "underlay"]},
 978         "ip-address": {"oneOf": [ip_schema, ipv6_schema]},
 979         # TODO, add user, password, ssh-key
 980         "mac-address": mac_schema,
 981         "vim-network-name": shortname_schema,  # interface is connected to one vim network, or switch port
 982         "vim-network-id": shortname_schema,
 983         # # provide this in case SDN assist must deal with this interface
 984         # "switch-dpid": dpid_Schema,
 985         # "switch-port": shortname_schema,
 986         # "switch-mac": shortname_schema,
 987         # "switch-vlan": vlan_schema,
 988     },
 989     "required": ["name", "mgmt", "ip-address"],
 990     "additionalProperties": False,
 991 }
 992 pdu_new_schema = {
 993     "title": "pdu creation input schema",
 994     "$schema": "http://json-schema.org/draft-04/schema#",
 995     "type": "object",
 996     "properties": {
 997         "name": shortname_schema,
 998         "type": shortname_schema,
 999         "description": description_schema,
1000         "shared": bool_schema,
1001         "vims": nameshort_list_schema,
1002         "vim_accounts": nameshort_list_schema,
1003         "interfaces": {"type": "array", "items": pdu_interface, "minItems": 1},
1004     },
1005     "required": ["name", "type", "interfaces"],
1006     "additionalProperties": False,
1007 }
1008 pdu_edit_schema = {
1009     "title": "pdu edit input schema",
1010     "$schema": "http://json-schema.org/draft-04/schema#",
1011     "type": "object",
1012     "properties": {
1013         "name": shortname_schema,
1014         "type": shortname_schema,
1015         "description": description_schema,
1016         "shared": bool_schema,
1017         "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]},
1018         "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]},
1019         "interfaces": {
1020             "oneOf": [
1021                 array_edition_schema,
1022                 {"type": "array", "items": pdu_interface, "minItems": 1},
1023             ]
1024         },
1025     },
1026     "additionalProperties": False,
1027     "minProperties": 1,
1028 }
1029
1030 # VNF PKG OPERATIONS
1031 vnfpkgop_new_schema = {
1032     "title": "VNF PKG operation creation input schema",
1033     "$schema": "http://json-schema.org/draft-04/schema#",
1034     "type": "object",
1035     "properties": {
1036         "lcmOperationType": string_schema,
1037         "vnfPkgId": id_schema,
1038         "kdu_name": name_schema,
1039         "primitive": name_schema,
1040         "primitive_params": {"type": "object"},
1041     },
1042     "required": [
1043         "lcmOperationType",
1044         "vnfPkgId",
1045         "kdu_name",
1046         "primitive",
1047         "primitive_params",
1048     ],
1049     "additionalProperties": False,
1050 }
1051
1052 # USERS
1053 project_role_mappings = {
1054     "title": "list pf projects/roles",
1055     "$schema": "http://json-schema.org/draft-04/schema#",
1056     "type": "array",
1057     "items": {
1058         "type": "object",
1059         "properties": {"project": shortname_schema, "role": shortname_schema},
1060         "required": ["project", "role"],
1061         "additionalProperties": False,
1062     },
1063     "minItems": 1,
1064 }
1065 project_role_mappings_optional = {
1066     "title": "list of projects/roles or projects only",
1067     "$schema": "http://json-schema.org/draft-04/schema#",
1068     "type": "array",
1069     "items": {
1070         "type": "object",
1071         "properties": {"project": shortname_schema, "role": shortname_schema},
1072         "required": ["project"],
1073         "additionalProperties": False,
1074     },
1075     "minItems": 1,
1076 }
1077 user_new_schema = {
1078     "$schema": "http://json-schema.org/draft-04/schema#",
1079     "title": "New user schema",
1080     "type": "object",
1081     "properties": {
1082         "username": string_schema,
1083         "domain_name": shortname_schema,
1084         "password": passwd_schema,
1085         "projects": nameshort_list_schema,
1086         "project_role_mappings": project_role_mappings,
1087     },
1088     "required": ["username", "password"],
1089     "additionalProperties": False,
1090 }
1091 user_edit_schema = {
1092     "$schema": "http://json-schema.org/draft-04/schema#",
1093     "title": "User edit schema for administrators",
1094     "type": "object",
1095     "properties": {
1096         "password": passwd_schema,
1097         "old_password": passwd_schema,
1098         "username": string_schema,  # To allow User Name modification
1099         "projects": {"oneOf": [nameshort_list_schema, array_edition_schema]},
1100         "project_role_mappings": project_role_mappings,
1101         "add_project_role_mappings": project_role_mappings,
1102         "remove_project_role_mappings": project_role_mappings_optional,
1103     },
1104     "minProperties": 1,
1105     "additionalProperties": False,
1106 }
1107
1108 # PROJECTS
1109 topics_with_quota = [
1110     "vnfds",
1111     "nsds",
1112     "slice_templates",
1113     "pduds",
1114     "ns_instances",
1115     "slice_instances",
1116     "vim_accounts",
1117     "wim_accounts",
1118     "sdn_controllers",
1119     "k8sclusters",
1120     "vca",
1121     "k8srepos",
1122     "osmrepos",
1123     "ns_subscriptions",
1124 ]
1125 project_new_schema = {
1126     "$schema": "http://json-schema.org/draft-04/schema#",
1127     "title": "New project schema for administrators",
1128     "type": "object",
1129     "properties": {
1130         "name": shortname_schema,
1131         "admin": bool_schema,
1132         "domain_name": shortname_schema,
1133         "quotas": {
1134             "type": "object",
1135             "properties": {topic: integer0_schema for topic in topics_with_quota},
1136             "additionalProperties": False,
1137         },
1138     },
1139     "required": ["name"],
1140     "additionalProperties": False,
1141 }
1142 project_edit_schema = {
1143     "$schema": "http://json-schema.org/draft-04/schema#",
1144     "title": "Project edit schema for administrators",
1145     "type": "object",
1146     "properties": {
1147         "admin": bool_schema,
1148         "name": shortname_schema,  # To allow Project Name modification
1149         "quotas": {
1150             "type": "object",
1151             "properties": {
1152                 topic: {"oneOf": [integer0_schema, null_schema]}
1153                 for topic in topics_with_quota
1154             },
1155             "additionalProperties": False,
1156         },
1157     },
1158     "additionalProperties": False,
1159     "minProperties": 1,
1160 }
1161
1162 # ROLES
1163 roles_new_schema = {
1164     "$schema": "http://json-schema.org/draft-04/schema#",
1165     "title": "New role schema for administrators",
1166     "type": "object",
1167     "properties": {
1168         "name": shortname_schema,
1169         "permissions": {
1170             "type": "object",
1171             "patternProperties": {
1172                 ".": bool_schema,
1173             },
1174             # "minProperties": 1,
1175         },
1176     },
1177     "required": ["name"],
1178     "additionalProperties": False,
1179 }
1180 roles_edit_schema = {
1181     "$schema": "http://json-schema.org/draft-04/schema#",
1182     "title": "Roles edit schema for administrators",
1183     "type": "object",
1184     "properties": {
1185         "name": shortname_schema,
1186         "permissions": {
1187             "type": "object",
1188             "patternProperties": {".": {"oneOf": [bool_schema, null_schema]}},
1189             # "minProperties": 1,
1190         },
1191     },
1192     "additionalProperties": False,
1193     "minProperties": 1,
1194 }
1195
1196 # GLOBAL SCHEMAS
1197
1198 nbi_new_input_schemas = {
1199     "users": user_new_schema,
1200     "projects": project_new_schema,
1201     "vim_accounts": vim_account_new_schema,
1202     "sdns": sdn_new_schema,
1203     "ns_instantiate": ns_instantiate,
1204     "ns_action": ns_action,
1205     "ns_scale": ns_scale,
1206     "ns_update": ns_update,
1207     "ns_heal": ns_heal,
1208     "pdus": pdu_new_schema,
1209 }
1210
1211 nbi_edit_input_schemas = {
1212     "users": user_edit_schema,
1213     "projects": project_edit_schema,
1214     "vim_accounts": vim_account_edit_schema,
1215     "sdns": sdn_edit_schema,
1216     "pdus": pdu_edit_schema,
1217 }
1218
1219 # NETSLICE SCHEMAS
1220 nsi_subnet_instantiate = deepcopy(ns_instantiate)
1221 nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema"
1222 nsi_subnet_instantiate["properties"]["id"] = name_schema
1223 del nsi_subnet_instantiate["required"]
1224
1225 nsi_vld_instantiate = {
1226     "title": "netslice vld instantiation params input schema",
1227     "$schema": "http://json-schema.org/draft-04/schema#",
1228     "type": "object",
1229     "properties": {
1230         "name": string_schema,
1231         "vim-network-name": {"oneOf": [string_schema, object_schema]},
1232         "vim-network-id": {"oneOf": [string_schema, object_schema]},
1233         "ip-profile": object_schema,
1234     },
1235     "required": ["name"],
1236     "additionalProperties": False,
1237 }
1238
1239 nsi_instantiate = {
1240     "title": "netslice action instantiate input schema",
1241     "$schema": "http://json-schema.org/draft-04/schema#",
1242     "type": "object",
1243     "properties": {
1244         "lcmOperationType": string_schema,
1245         "netsliceInstanceId": id_schema,
1246         "nsiName": name_schema,
1247         "nsiDescription": {"oneOf": [description_schema, null_schema]},
1248         "nstId": string_schema,
1249         "vimAccountId": id_schema,
1250         "timeout_nsi_deploy": integer1_schema,
1251         "ssh_keys": {"type": "array", "items": {"type": "string"}},
1252         "nsi_id": id_schema,
1253         "additionalParamsForNsi": object_schema,
1254         "netslice-subnet": {
1255             "type": "array",
1256             "minItems": 1,
1257             "items": nsi_subnet_instantiate,
1258         },
1259         "netslice-vld": {"type": "array", "minItems": 1, "items": nsi_vld_instantiate},
1260     },
1261     "required": ["nsiName", "nstId", "vimAccountId"],
1262     "additionalProperties": False,
1263 }
1264
1265 nsi_action = {}
1266
1267 nsi_terminate = {}
1268
1269 nsinstancesubscriptionfilter_schema = {
1270     "title": "instance identifier schema",
1271     "$schema": "http://json-schema.org/draft-07/schema#",
1272     "type": "object",
1273     "properties": {
1274         "nsdIds": {"type": "array"},
1275         "vnfdIds": {"type": "array"},
1276         "pnfdIds": {"type": "array"},
1277         "nsInstanceIds": {"type": "array"},
1278         "nsInstanceNames": {"type": "array"},
1279     },
1280 }
1281
1282 nslcmsub_schema = {
1283     "title": "nslcmsubscription input schema",
1284     "$schema": "http://json-schema.org/draft-07/schema#",
1285     "type": "object",
1286     "properties": {
1287         "nsInstanceSubscriptionFilter": nsinstancesubscriptionfilter_schema,
1288         "notificationTypes": {
1289             "type": "array",
1290             "items": {
1291                 "enum": [
1292                     "NsLcmOperationOccurrenceNotification",
1293                     "NsChangeNotification",
1294                     "NsIdentifierCreationNotification",
1295                     "NsIdentifierDeletionNotification",
1296                 ]
1297             },
1298         },
1299         "operationTypes": {
1300             "type": "array",
1301             "items": {"enum": ["INSTANTIATE", "SCALE", "TERMINATE", "UPDATE", "HEAL"]},
1302         },
1303         "operationStates": {
1304             "type": "array",
1305             "items": {
1306                 "enum": [
1307                     "PROCESSING",
1308                     "COMPLETED",
1309                     "PARTIALLY_COMPLETED",
1310                     "FAILED",
1311                     "FAILED_TEMP",
1312                     "ROLLING_BACK",
1313                     "ROLLED_BACK",
1314                 ]
1315             },
1316         },
1317         "nsComponentTypes": {"type": "array", "items": {"enum": ["VNF", "NS", "PNF"]}},
1318         "lcmOpNameImpactingNsComponent": {
1319             "type": "array",
1320             "items": {
1321                 "enum": [
1322                     "VNF_INSTANTIATE",
1323                     "VNF_SCALE",
1324                     "VNF_SCALE_TO_LEVEL",
1325                     "VNF_CHANGE_FLAVOUR",
1326                     "VNF_TERMINATE",
1327                     "VNF_HEAL",
1328                     "VNF_OPERATE",
1329                     "VNF_CHANGE_EXT_CONN",
1330                     "VNF_MODIFY_INFO",
1331                     "NS_INSTANTIATE",
1332                     "NS_SCALE",
1333                     "NS_UPDATE",
1334                     "NS_TERMINATE",
1335                     "NS_HEAL",
1336                 ]
1337             },
1338         },
1339         "lcmOpOccStatusImpactingNsComponent": {
1340             "type": "array",
1341             "items": {
1342                 "enum": [
1343                     "START",
1344                     "COMPLETED",
1345                     "PARTIALLY_COMPLETED",
1346                     "FAILED",
1347                     "ROLLED_BACK",
1348                 ]
1349             },
1350         },
1351     },
1352     "allOf": [
1353         {
1354             "if": {
1355                 "properties": {
1356                     "notificationTypes": {
1357                         "contains": {"const": "NsLcmOperationOccurrenceNotification"}
1358                     }
1359                 },
1360             },
1361             "then": {
1362                 "anyOf": [
1363                     {"required": ["operationTypes"]},
1364                     {"required": ["operationStates"]},
1365                 ]
1366             },
1367         },
1368         {
1369             "if": {
1370                 "properties": {
1371                     "notificationTypes": {"contains": {"const": "NsChangeNotification"}}
1372                 },
1373             },
1374             "then": {
1375                 "anyOf": [
1376                     {"required": ["nsComponentTypes"]},
1377                     {"required": ["lcmOpNameImpactingNsComponent"]},
1378                     {"required": ["lcmOpOccStatusImpactingNsComponent"]},
1379                 ]
1380             },
1381         },
1382     ],
1383 }
1384
1385 authentication_schema = {
1386     "title": "authentication schema for subscription",
1387     "$schema": "http://json-schema.org/draft-07/schema#",
1388     "type": "object",
1389     "properties": {
1390         "authType": {"enum": ["basic"]},
1391         "paramsBasic": {
1392             "type": "object",
1393             "properties": {
1394                 "userName": string_schema,
1395                 "password": passwd_schema,
1396             },
1397         },
1398     },
1399 }
1400
1401 subscription = {
1402     "title": "subscription input schema",
1403     "$schema": "http://json-schema.org/draft-07/schema#",
1404     "type": "object",
1405     "properties": {
1406         "filter": nslcmsub_schema,
1407         "CallbackUri": description_schema,
1408         "authentication": authentication_schema,
1409     },
1410     "required": ["CallbackUri"],
1411 }
1412
1413 vnflcmsub_schema = {
1414     "title": "vnflcmsubscription input schema",
1415     "$schema": "http://json-schema.org/draft-07/schema#",
1416     "type": "object",
1417     "properties": {
1418         "VnfInstanceSubscriptionFilter": {
1419             "type": "object",
1420             "properties": {
1421                 "vnfdIds": {"type": "array"},
1422                 "vnfInstanceIds": {"type": "array"},
1423             },
1424         },
1425         "notificationTypes": {
1426             "type": "array",
1427             "items": {
1428                 "enum": [
1429                     "VnfIdentifierCreationNotification",
1430                     "VnfLcmOperationOccurrenceNotification",
1431                     "VnfIdentifierDeletionNotification"
1432                     ]
1433             }
1434         },
1435         "operationTypes": {
1436             "type": "array",
1437             "items": {
1438                 "enum": [
1439                     "INSTANTIATE", "SCALE", "SCALE_TO_LEVEL", "CHANGE_FLAVOUR", "TERMINATE",
1440                     "HEAL", "OPERATE", "CHANGE_EXT_CONN", "MODIFY_INFO", "CREATE_SNAPSHOT",
1441                     "REVERT_TO_SNAPSHOT", "CHANGE_VNFPKG"
1442                     ]
1443             }
1444         },
1445         "operationStates": {
1446             "type": "array",
1447             "items": {
1448                 "enum": [
1449                     "STARTING", "PROCESSING", "COMPLETED", "FAILED_TEMP", "FAILED",
1450                     "ROLLING_BACK", "ROLLED_BACK"
1451                     ]
1452             }
1453         }
1454     },
1455     "required": ["VnfInstanceSubscriptionFilter", "notificationTypes"]
1456  }
1457
1458 vnf_subscription = {
1459     "title": "vnf subscription input schema",
1460     "$schema": "http://json-schema.org/draft-07/schema#",
1461     "type": "object",
1462     "properties": {
1463         "filter": vnflcmsub_schema,
1464         "CallbackUri": description_schema,
1465         "authentication": authentication_schema
1466     },
1467     "required": ["filter", "CallbackUri"]
1468 }
1469
1470
1471 class ValidationError(Exception):
1472     def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY):
1473         self.http_code = http_code
1474         Exception.__init__(self, message)
1475
1476
1477 def validate_input(indata, schema_to_use):
1478     """
1479     Validates input data against json schema
1480     :param indata: user input data. Should be a dictionary
1481     :param schema_to_use: jsonschema to test
1482     :return: None if ok, raises ValidationError exception on error
1483     """
1484     try:
1485         if schema_to_use:
1486             js_v(indata, schema_to_use)
1487         return None
1488     except js_e.ValidationError as e:
1489         if e.path:
1490             error_pos = "at '" + ":".join(map(str, e.path)) + "'"
1491         else:
1492             error_pos = ""
1493         raise ValidationError("Format error {} '{}' ".format(error_pos, e.message))
1494     except js_e.SchemaError:
1495         raise ValidationError(
1496             "Bad json schema {}".format(schema_to_use),
1497             http_code=HTTPStatus.INTERNAL_SERVER_ERROR,
1498         )
1499
1500
1501 def is_valid_uuid(x):
1502     """
1503     Test for a valid UUID
1504     :param x: string to test
1505     :return: True if x is a valid uuid, False otherwise
1506     """
1507     try:
1508         if UUID(x):
1509             return True
1510     except (TypeError, ValueError, AttributeError):
1511         return False