docs/platform/APIs/CATALOG_API/CATALOG_API_Specification_v0.1.json

   1 {
   2         "swagger": "2.0",
   3         "info": {
   4                 "title": "VFC Catalog API",
   5                 "description": "\n\nThe `swagger-ui` view can be found [here](/api/catalog/v1/swagger).\nThe `ReDoc` view can be found [here](/api/catalog/v1/redoc).\nThe swagger YAML document can be found [here](/api/catalog/v1/swagger.yaml).\nThe swagger JSON document can be found [here](/api/catalog/v1/swagger.json).",
   6                 "version": "v1"
   7         },
   8         "host": "127.0.0.1:8000",
   9         "schemes": ["http"],
  10         "basePath": "/",
  11         "paths": {
  12                 "/api/catalog/v1/jobs/{job_id}": {
  13                         "get": {
  14                                 "operationId": "api_catalog_v1_jobs_read",
  15                                 "description": "Get job status",
  16                                 "parameters": [{
  17                                         "name": "job_id",
  18                                         "in": "query",
  19                                         "description": "job id",
  20                                         "type": "string"
  21                                 }, {
  22                                         "name": "responseId",
  23                                         "in": "query",
  24                                         "description": "response id",
  25                                         "type": "string"
  26                                 }],
  27                                 "responses": {
  28                                         "200": {
  29                                                 "description": "",
  30                                                 "schema": {
  31                                                         "$ref": "#/definitions/GetJobResponse"
  32                                                 }
  33                                         },
  34                                         "500": {
  35                                                 "description": "",
  36                                                 "schema": {
  37                                                         "$ref": "#/definitions/PostJobResponseResult"
  38                                                 }
  39                                         }
  40                                 },
  41                                 "consumes": ["application/json"],
  42                                 "tags": ["api"]
  43                         },
  44                         "post": {
  45                                 "operationId": "api_catalog_v1_jobs_create",
  46                                 "description": "Update job status",
  47                                 "parameters": [{
  48                                         "name": "data",
  49                                         "in": "body",
  50                                         "required": true,
  51                                         "schema": {
  52                                                 "$ref": "#/definitions/PostJobRequest"
  53                                         }
  54                                 }, {
  55                                         "name": "job_id",
  56                                         "in": "query",
  57                                         "description": "job id",
  58                                         "type": "string"
  59                                 }],
  60                                 "responses": {
  61                                         "202": {
  62                                                 "description": "",
  63                                                 "schema": {
  64                                                         "$ref": "#/definitions/PostJobResponseResult"
  65                                                 }
  66                                         },
  67                                         "500": {
  68                                                 "description": "",
  69                                                 "schema": {
  70                                                         "$ref": "#/definitions/PostJobResponseResult"
  71                                                 }
  72                                         }
  73                                 },
  74                                 "consumes": ["application/json"],
  75                                 "tags": ["api"]
  76                         },
  77                         "parameters": [{
  78                                 "name": "job_id",
  79                                 "in": "path",
  80                                 "required": true,
  81                                 "type": "string"
  82                         }]
  83                 },
  84                 "/api/catalog/v1/mandb/{modelName}": {
  85                         "get": {
  86                                 "operationId": "api_catalog_v1_mandb_read",
  87                                 "description": "",
  88                                 "parameters": [],
  89                                 "responses": {
  90                                         "200": {
  91                                                 "description": ""
  92                                         }
  93                                 },
  94                                 "consumes": ["application/json"],
  95                                 "tags": ["api"]
  96                         },
  97                         "delete": {
  98                                 "operationId": "api_catalog_v1_mandb_delete",
  99                                 "description": "",
 100                                 "parameters": [],
 101                                 "responses": {
 102                                         "204": {
 103                                                 "description": ""
 104                                         }
 105                                 },
 106                                 "consumes": ["application/json"],
 107                                 "tags": ["api"]
 108                         },
 109                         "parameters": [{
 110                                 "name": "modelName",
 111                                 "in": "path",
 112                                 "required": true,
 113                                 "type": "string"
 114                         }]
 115                 },
 116                 "/api/catalog/v1/nspackages": {
 117                         "get": {
 118                                 "operationId": "api_catalog_v1_nspackages_list",
 119                                 "description": "Query NS packages",
 120                                 "parameters": [],
 121                                 "responses": {
 122                                         "200": {
 123                                                 "description": "",
 124                                                 "schema": {
 125                                                         "type": "array",
 126                                                         "items": {
 127                                                                 "$ref": "#/definitions/NsPackage"
 128                                                         }
 129                                                 }
 130                                         },
 131                                         "500": {
 132                                                 "description": "",
 133                                                 "schema": {
 134                                                         "$ref": "#/definitions/InternalErrorRequest"
 135                                                 }
 136                                         }
 137                                 },
 138                                 "consumes": ["application/json"],
 139                                 "tags": ["api"]
 140                         },
 141                         "post": {
 142                                 "operationId": "api_catalog_v1_nspackages_create",
 143                                 "description": "On distribute NS package",
 144                                 "parameters": [{
 145                                         "name": "data",
 146                                         "in": "body",
 147                                         "required": true,
 148                                         "schema": {
 149                                                 "$ref": "#/definitions/NsPackageDistributeRequest"
 150                                         }
 151                                 }],
 152                                 "responses": {
 153                                         "202": {
 154                                                 "description": "",
 155                                                 "schema": {
 156                                                         "$ref": "#/definitions/NsPackageDistributeResponse"
 157                                                 }
 158                                         },
 159                                         "500": {
 160                                                 "description": "",
 161                                                 "schema": {
 162                                                         "$ref": "#/definitions/InternalErrorRequest"
 163                                                 }
 164                                         }
 165                                 },
 166                                 "consumes": ["application/json"],
 167                                 "tags": ["api"]
 168                         },
 169                         "parameters": []
 170                 },
 171                 "/api/catalog/v1/nspackages/{csarId}": {
 172                         "get": {
 173                                 "operationId": "api_catalog_v1_nspackages_read",
 174                                 "description": "Query one NS package",
 175                                 "parameters": [{
 176                                         "name": "csarId",
 177                                         "in": "query",
 178                                         "description": "csarId",
 179                                         "type": "string"
 180                                 }],
 181                                 "responses": {
 182                                         "200": {
 183                                                 "description": "",
 184                                                 "schema": {
 185                                                         "$ref": "#/definitions/NsPackage"
 186                                                 }
 187                                         },
 188                                         "500": {
 189                                                 "description": "error message",
 190                                                 "schema": {
 191                                                         "type": "string"
 192                                                 }
 193                                         }
 194                                 },
 195                                 "consumes": ["application/json"],
 196                                 "tags": ["api"]
 197                         },
 198                         "delete": {
 199                                 "operationId": "api_catalog_v1_nspackages_delete",
 200                                 "description": "Delete one NS package",
 201                                 "parameters": [{
 202                                         "name": "csarId",
 203                                         "in": "query",
 204                                         "description": "csarId",
 205                                         "type": "string"
 206                                 }],
 207                                 "responses": {
 208                                         "200": {
 209                                                 "description": "",
 210                                                 "schema": {
 211                                                         "$ref": "#/definitions/NsPackageDistributeResponse"
 212                                                 }
 213                                         },
 214                                         "500": {
 215                                                 "description": "error message",
 216                                                 "schema": {
 217                                                         "type": "string"
 218                                                 }
 219                                         }
 220                                 },
 221                                 "consumes": ["application/json"],
 222                                 "tags": ["api"]
 223                         },
 224                         "parameters": [{
 225                                 "name": "csarId",
 226                                 "in": "path",
 227                                 "required": true,
 228                                 "type": "string"
 229                         }]
 230                 },
 231                 "/api/catalog/v1/parsernsd": {
 232                         "post": {
 233                                 "operationId": "api_catalog_v1_parsernsd_create",
 234                                 "description": "Parse NS model",
 235                                 "parameters": [{
 236                                         "name": "data",
 237                                         "in": "body",
 238                                         "required": true,
 239                                         "schema": {
 240                                                 "$ref": "#/definitions/ParseModelRequest"
 241                                         }
 242                                 }],
 243                                 "responses": {
 244                                         "202": {
 245                                                 "description": "",
 246                                                 "schema": {
 247                                                         "$ref": "#/definitions/ParseModelResponse"
 248                                                 }
 249                                         },
 250                                         "500": {
 251                                                 "description": "",
 252                                                 "schema": {
 253                                                         "$ref": "#/definitions/InternalErrorRequest"
 254                                                 }
 255                                         }
 256                                 },
 257                                 "consumes": ["application/json"],
 258                                 "tags": ["api"]
 259                         },
 260                         "parameters": []
 261                 },
 262                 "/api/catalog/v1/parserpnfd": {
 263                         "post": {
 264                                 "operationId": "api_catalog_v1_parserpnfd_create",
 265                                 "description": "Parse PNF model",
 266                                 "parameters": [{
 267                                         "name": "data",
 268                                         "in": "body",
 269                                         "required": true,
 270                                         "schema": {
 271                                                 "$ref": "#/definitions/ParseModelRequest"
 272                                         }
 273                                 }],
 274                                 "responses": {
 275                                         "202": {
 276                                                 "description": "",
 277                                                 "schema": {
 278                                                         "$ref": "#/definitions/ParseModelResponse"
 279                                                 }
 280                                         },
 281                                         "500": {
 282                                                 "description": "",
 283                                                 "schema": {
 284                                                         "$ref": "#/definitions/InternalErrorRequest"
 285                                                 }
 286                                         }
 287                                 },
 288                                 "consumes": ["application/json"],
 289                                 "tags": ["api"]
 290                         },
 291                         "parameters": []
 292                 },
 293                 "/api/catalog/v1/parservnfd": {
 294                         "post": {
 295                                 "operationId": "api_catalog_v1_parservnfd_create",
 296                                 "description": "Parse NF model",
 297                                 "parameters": [{
 298                                         "name": "data",
 299                                         "in": "body",
 300                                         "required": true,
 301                                         "schema": {
 302                                                 "$ref": "#/definitions/ParseModelRequest"
 303                                         }
 304                                 }],
 305                                 "responses": {
 306                                         "202": {
 307                                                 "description": "",
 308                                                 "schema": {
 309                                                         "$ref": "#/definitions/ParseModelResponse"
 310                                                 }
 311                                         },
 312                                         "500": {
 313                                                 "description": "",
 314                                                 "schema": {
 315                                                         "$ref": "#/definitions/InternalErrorRequest"
 316                                                 }
 317                                         }
 318                                 },
 319                                 "consumes": ["application/json"],
 320                                 "tags": ["api"]
 321                         },
 322                         "parameters": []
 323                 },
 324                 "/api/catalog/v1/vnfpackages": {
 325                         "get": {
 326                                 "operationId": "api_catalog_v1_vnfpackages_list",
 327                                 "description": "Query Nf packages",
 328                                 "parameters": [],
 329                                 "responses": {
 330                                         "200": {
 331                                                 "description": "",
 332                                                 "schema": {
 333                                                         "type": "array",
 334                                                         "items": {
 335                                                                 "$ref": "#/definitions/NfPackage"
 336                                                         }
 337                                                 }
 338                                         },
 339                                         "500": {
 340                                                 "description": "",
 341                                                 "schema": {
 342                                                         "$ref": "#/definitions/InternalErrorRequest"
 343                                                 }
 344                                         }
 345                                 },
 346                                 "consumes": ["application/json"],
 347                                 "tags": ["api"]
 348                         },
 349                         "post": {
 350                                 "operationId": "api_catalog_v1_vnfpackages_create",
 351                                 "description": "On distribute Nf package",
 352                                 "parameters": [{
 353                                         "name": "data",
 354                                         "in": "body",
 355                                         "required": true,
 356                                         "schema": {
 357                                                 "$ref": "#/definitions/NfPackageDistributeRequest"
 358                                         }
 359                                 }],
 360                                 "responses": {
 361                                         "202": {
 362                                                 "description": "",
 363                                                 "schema": {
 364                                                         "$ref": "#/definitions/PostJobResponse"
 365                                                 }
 366                                         },
 367                                         "500": {
 368                                                 "description": "",
 369                                                 "schema": {
 370                                                         "$ref": "#/definitions/InternalErrorRequest"
 371                                                 }
 372                                         }
 373                                 },
 374                                 "consumes": ["application/json"],
 375                                 "tags": ["api"]
 376                         },
 377                         "parameters": []
 378                 },
 379                 "/api/catalog/v1/vnfpackages/{csarId}": {
 380                         "get": {
 381                                 "operationId": "api_catalog_v1_vnfpackages_read",
 382                                 "description": "Query one Nf package",
 383                                 "parameters": [{
 384                                         "name": "csarId",
 385                                         "in": "query",
 386                                         "description": "csarId",
 387                                         "type": "string"
 388                                 }],
 389                                 "responses": {
 390                                         "200": {
 391                                                 "description": "",
 392                                                 "schema": {
 393                                                         "$ref": "#/definitions/NfPackage"
 394                                                 }
 395                                         },
 396                                         "500": {
 397                                                 "description": "error message",
 398                                                 "schema": {
 399                                                         "type": "string"
 400                                                 }
 401                                         }
 402                                 },
 403                                 "consumes": ["application/json"],
 404                                 "tags": ["api"]
 405                         },
 406                         "delete": {
 407                                 "operationId": "api_catalog_v1_vnfpackages_delete",
 408                                 "description": "Delete one Nf package",
 409                                 "parameters": [{
 410                                         "name": "csarId",
 411                                         "in": "query",
 412                                         "description": "csarId",
 413                                         "type": "string"
 414                                 }],
 415                                 "responses": {
 416                                         "202": {
 417                                                 "description": "",
 418                                                 "schema": {
 419                                                         "$ref": "#/definitions/PostJobResponse"
 420                                                 }
 421                                         },
 422                                         "500": {
 423                                                 "description": "error message",
 424                                                 "schema": {
 425                                                         "type": "string"
 426                                                 }
 427                                         }
 428                                 },
 429                                 "consumes": ["application/json"],
 430                                 "tags": ["api"]
 431                         },
 432                         "parameters": [{
 433                                 "name": "csarId",
 434                                 "in": "path",
 435                                 "required": true,
 436                                 "type": "string"
 437                         }]
 438                 },
 439                 "/api/nsd/v1/ns_descriptors": {
 440                         "get": {
 441                                 "operationId": "api_nsd_v1_ns_descriptors_list",
 442                                 "description": "Query multiple NSDs",
 443                                 "parameters": [],
 444                                 "responses": {
 445                                         "200": {
 446                                                 "description": "",
 447                                                 "schema": {
 448                                                         "type": "array",
 449                                                         "items": {
 450                                                                 "$ref": "#/definitions/NsdInfo"
 451                                                         }
 452                                                 }
 453                                         },
 454                                         "500": {
 455                                                 "description": "Internal error"
 456                                         }
 457                                 },
 458                                 "consumes": ["application/json"],
 459                                 "tags": ["api"]
 460                         },
 461                         "post": {
 462                                 "operationId": "api_nsd_v1_ns_descriptors_create",
 463                                 "description": "Create a NSD",
 464                                 "parameters": [{
 465                                         "name": "data",
 466                                         "in": "body",
 467                                         "required": true,
 468                                         "schema": {
 469                                                 "$ref": "#/definitions/CreateNsdInfoRequest"
 470                                         }
 471                                 }],
 472                                 "responses": {
 473                                         "201": {
 474                                                 "description": "",
 475                                                 "schema": {
 476                                                         "$ref": "#/definitions/NsdInfo"
 477                                                 }
 478                                         },
 479                                         "500": {
 480                                                 "description": "Internal error"
 481                                         }
 482                                 },
 483                                 "consumes": ["application/json"],
 484                                 "tags": ["api"]
 485                         },
 486                         "parameters": []
 487                 },
 488                 "/api/nsd/v1/ns_descriptors/{nsdInfoId}": {
 489                         "get": {
 490                                 "operationId": "api_nsd_v1_ns_descriptors_read",
 491                                 "description": "Query a NSD",
 492                                 "parameters": [],
 493                                 "responses": {
 494                                         "200": {
 495                                                 "description": "",
 496                                                 "schema": {
 497                                                         "$ref": "#/definitions/NsdInfo"
 498                                                 }
 499                                         },
 500                                         "500": {
 501                                                 "description": "Internal error"
 502                                         },
 503                                         "404": {
 504                                                 "description": "NSDs do not exist"
 505                                         }
 506                                 },
 507                                 "consumes": ["application/json"],
 508                                 "tags": ["api"]
 509                         },
 510                         "delete": {
 511                                 "operationId": "api_nsd_v1_ns_descriptors_delete",
 512                                 "description": "Delete a NSD",
 513                                 "parameters": [],
 514                                 "responses": {
 515                                         "500": {
 516                                                 "description": "Internal error"
 517                                         },
 518                                         "204": {
 519                                                 "description": "No content"
 520                                         }
 521                                 },
 522                                 "consumes": ["application/json"],
 523                                 "tags": ["api"]
 524                         },
 525                         "parameters": [{
 526                                 "name": "nsdInfoId",
 527                                 "in": "path",
 528                                 "required": true,
 529                                 "type": "string"
 530                         }]
 531                 },
 532                 "/api/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content": {
 533                         "get": {
 534                                 "operationId": "api_nsd_v1_ns_descriptors_nsd_content_list",
 535                                 "description": "Download NSD content",
 536                                 "parameters": [],
 537                                 "responses": {
 538                                         "404": {
 539                                                 "description": "NSD does not exist."
 540                                         },
 541                                         "204": {
 542                                                 "description": "No content"
 543                                         },
 544                                         "500": {
 545                                                 "description": "Internal error"
 546                                         }
 547                                 },
 548                                 "consumes": ["application/json"],
 549                                 "tags": ["api"]
 550                         },
 551                         "put": {
 552                                 "operationId": "api_nsd_v1_ns_descriptors_nsd_content_update",
 553                                 "description": "Upload NSD content",
 554                                 "parameters": [],
 555                                 "responses": {
 556                                         "500": {
 557                                                 "description": "Internal error"
 558                                         },
 559                                         "204": {
 560                                                 "description": "PNFD file"
 561                                         }
 562                                 },
 563                                 "consumes": ["application/json"],
 564                                 "tags": ["api"]
 565                         },
 566                         "parameters": [{
 567                                 "name": "nsdInfoId",
 568                                 "in": "path",
 569                                 "required": true,
 570                                 "type": "string"
 571                         }]
 572                 },
 573                 "/api/nsd/v1/pnf_descriptors": {
 574                         "get": {
 575                                 "operationId": "api_nsd_v1_pnf_descriptors_list",
 576                                 "description": "Query multiple PNFDs",
 577                                 "parameters": [],
 578                                 "responses": {
 579                                         "200": {
 580                                                 "description": "",
 581                                                 "schema": {
 582                                                         "type": "array",
 583                                                         "items": {
 584                                                                 "$ref": "#/definitions/PnfdInfo"
 585                                                         }
 586                                                 }
 587                                         },
 588                                         "500": {
 589                                                 "description": "Internal error"
 590                                         }
 591                                 },
 592                                 "consumes": ["application/json"],
 593                                 "tags": ["api"]
 594                         },
 595                         "post": {
 596                                 "operationId": "api_nsd_v1_pnf_descriptors_create",
 597                                 "description": "Create a  PNFD",
 598                                 "parameters": [{
 599                                         "name": "data",
 600                                         "in": "body",
 601                                         "required": true,
 602                                         "schema": {
 603                                                 "$ref": "#/definitions/CreatePnfdInfoRequest"
 604                                         }
 605                                 }],
 606                                 "responses": {
 607                                         "201": {
 608                                                 "description": "",
 609                                                 "schema": {
 610                                                         "$ref": "#/definitions/PnfdInfo"
 611                                                 }
 612                                         },
 613                                         "500": {
 614                                                 "description": "Internal error"
 615                                         }
 616                                 },
 617                                 "consumes": ["application/json"],
 618                                 "tags": ["api"]
 619                         },
 620                         "parameters": []
 621                 },
 622                 "/api/nsd/v1/pnf_descriptors/{pnfdInfoId}": {
 623                         "get": {
 624                                 "operationId": "api_nsd_v1_pnf_descriptors_read",
 625                                 "description": "Query a PNFD",
 626                                 "parameters": [],
 627                                 "responses": {
 628                                         "200": {
 629                                                 "description": "",
 630                                                 "schema": {
 631                                                         "$ref": "#/definitions/PnfdInfo"
 632                                                 }
 633                                         },
 634                                         "500": {
 635                                                 "description": "Internal error"
 636                                         },
 637                                         "404": {
 638                                                 "description": "PNFD does not exist"
 639                                         }
 640                                 },
 641                                 "consumes": ["application/json"],
 642                                 "tags": ["api"]
 643                         },
 644                         "delete": {
 645                                 "operationId": "api_nsd_v1_pnf_descriptors_delete",
 646                                 "description": "Delete a PNFD",
 647                                 "parameters": [],
 648                                 "responses": {
 649                                         "500": {
 650                                                 "description": "Internal error"
 651                                         },
 652                                         "204": {
 653                                                 "description": "No content"
 654                                         }
 655                                 },
 656                                 "consumes": ["application/json"],
 657                                 "tags": ["api"]
 658                         },
 659                         "parameters": [{
 660                                 "name": "pnfdInfoId",
 661                                 "in": "path",
 662                                 "required": true,
 663                                 "type": "string"
 664                         }]
 665                 },
 666                 "/api/nsd/v1/pnf_descriptors/{pnfdInfoId}/pnfd_content": {
 667                         "get": {
 668                                 "operationId": "api_nsd_v1_pnf_descriptors_pnfd_content_list",
 669                                 "description": "Fetch PNFD content",
 670                                 "parameters": [],
 671                                 "responses": {
 672                                         "404": {
 673                                                 "description": "PNFD does not exist"
 674                                         },
 675                                         "204": {
 676                                                 "description": "PNFD file"
 677                                         },
 678                                         "500": {
 679                                                 "description": "Internal error"
 680                                         }
 681                                 },
 682                                 "consumes": ["application/json"],
 683                                 "tags": ["api"]
 684                         },
 685                         "put": {
 686                                 "operationId": "api_nsd_v1_pnf_descriptors_pnfd_content_update",
 687                                 "description": "Upload PNFD content",
 688                                 "parameters": [],
 689                                 "responses": {
 690                                         "500": {
 691                                                 "description": "Internal error"
 692                                         },
 693                                         "204": {
 694                                                 "description": "No content"
 695                                         }
 696                                 },
 697                                 "consumes": ["application/json"],
 698                                 "tags": ["api"]
 699                         },
 700                         "parameters": [{
 701                                 "name": "pnfdInfoId",
 702                                 "in": "path",
 703                                 "required": true,
 704                                 "type": "string"
 705                         }]
 706                 },
 707                 "/api/vnfpkgm/v1/vnf_packages": {
 708                         "get": {
 709                                 "operationId": "api_vnfpkgm_v1_vnf_packages_list",
 710                                 "description": "Query multiple VNF package resource",
 711                                 "parameters": [],
 712                                 "responses": {
 713                                         "200": {
 714                                                 "description": "",
 715                                                 "schema": {
 716                                                         "type": "array",
 717                                                         "items": {
 718                                                                 "$ref": "#/definitions/VnfPkgInfo"
 719                                                         }
 720                                                 }
 721                                         },
 722                                         "500": {
 723                                                 "description": "Internal error"
 724                                         }
 725                                 },
 726                                 "consumes": ["application/json"],
 727                                 "tags": ["api"]
 728                         },
 729                         "post": {
 730                                 "operationId": "api_vnfpkgm_v1_vnf_packages_create",
 731                                 "description": "Create an individual VNF package resource",
 732                                 "parameters": [{
 733                                         "name": "data",
 734                                         "in": "body",
 735                                         "required": true,
 736                                         "schema": {
 737                                                 "$ref": "#/definitions/CreateVnfPkgInfoRequest"
 738                                         }
 739                                 }],
 740                                 "responses": {
 741                                         "201": {
 742                                                 "description": "",
 743                                                 "schema": {
 744                                                         "$ref": "#/definitions/VnfPkgInfo"
 745                                                 }
 746                                         },
 747                                         "500": {
 748                                                 "description": "Internal error"
 749                                         }
 750                                 },
 751                                 "consumes": ["application/json"],
 752                                 "tags": ["api"]
 753                         },
 754                         "parameters": []
 755                 },
 756                 "/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}": {
 757                         "get": {
 758                                 "operationId": "api_vnfpkgm_v1_vnf_packages_read",
 759                                 "description": "Query an individual VNF package resource",
 760                                 "parameters": [],
 761                                 "responses": {
 762                                         "200": {
 763                                                 "description": "",
 764                                                 "schema": {
 765                                                         "$ref": "#/definitions/VnfPkgInfo"
 766                                                 }
 767                                         },
 768                                         "500": {
 769                                                 "description": "Internal error"
 770                                         },
 771                                         "404": {
 772                                                 "description": "VNF package does not exist"
 773                                         }
 774                                 },
 775                                 "consumes": ["application/json"],
 776                                 "tags": ["api"]
 777                         },
 778                         "delete": {
 779                                 "operationId": "api_vnfpkgm_v1_vnf_packages_delete",
 780                                 "description": "Delete an individual VNF package resource",
 781                                 "parameters": [],
 782                                 "responses": {
 783                                         "500": {
 784                                                 "description": "Internal error"
 785                                         },
 786                                         "204": {
 787                                                 "description": "No content"
 788                                         }
 789                                 },
 790                                 "consumes": ["application/json"],
 791                                 "tags": ["api"]
 792                         },
 793                         "parameters": [{
 794                                 "name": "vnfPkgId",
 795                                 "in": "path",
 796                                 "required": true,
 797                                 "type": "string"
 798                         }]
 799                 },
 800                 "/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content": {
 801                         "get": {
 802                                 "operationId": "api_vnfpkgm_v1_vnf_packages_package_content_list",
 803                                 "description": "Fetch VNF package content",
 804                                 "parameters": [],
 805                                 "responses": {
 806                                         "200": {
 807                                                 "description": "",
 808                                                 "schema": {
 809                                                         "type": "array",
 810                                                         "items": {
 811                                                                 "$ref": "#/definitions/VnfPkgInfo"
 812                                                         }
 813                                                 }
 814                                         },
 815                                         "500": {
 816                                                 "description": "Internal error"
 817                                         },
 818                                         "404": {
 819                                                 "description": "VNF package does not exist"
 820                                         }
 821                                 },
 822                                 "consumes": ["application/json"],
 823                                 "tags": ["api"]
 824                         },
 825                         "put": {
 826                                 "operationId": "api_vnfpkgm_v1_vnf_packages_package_content_update",
 827                                 "description": "Upload VNF package content",
 828                                 "parameters": [],
 829                                 "responses": {
 830                                         "202": {
 831                                                 "description": "Successfully"
 832                                         },
 833                                         "500": {
 834                                                 "description": "Internal error"
 835                                         }
 836                                 },
 837                                 "consumes": ["application/json"],
 838                                 "tags": ["api"]
 839                         },
 840                         "parameters": [{
 841                                 "name": "vnfPkgId",
 842                                 "in": "path",
 843                                 "required": true,
 844                                 "type": "string"
 845                         }]
 846                 },
 847                 "/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content/upload_from_uri": {
 848                         "post": {
 849                                 "operationId": "api_vnfpkgm_v1_vnf_packages_package_content_upload_from_uri_create",
 850                                 "description": "Upload VNF package content from uri",
 851                                 "parameters": [{
 852                                         "name": "data",
 853                                         "in": "body",
 854                                         "required": true,
 855                                         "schema": {
 856                                                 "$ref": "#/definitions/UploadVnfPackageFromUriRequest"
 857                                         }
 858                                 }],
 859                                 "responses": {
 860                                         "202": {
 861                                                 "description": "Successfully"
 862                                         },
 863                                         "500": {
 864                                                 "description": "Internal error"
 865                                         }
 866                                 },
 867                                 "consumes": ["application/json"],
 868                                 "tags": ["api"]
 869                         },
 870                         "parameters": [{
 871                                 "name": "vnfPkgId",
 872                                 "in": "path",
 873                                 "required": true,
 874                                 "type": "string"
 875                         }]
 876                 },
 877                 "/samples/": {
 878                         "get": {
 879                                 "operationId": "samples_list",
 880                                 "description": "List all samples.",
 881                                 "parameters": [],
 882                                 "responses": {
 883                                         "200": {
 884                                                 "description": ""
 885                                         }
 886                                 },
 887                                 "consumes": ["application/json"],
 888                                 "tags": ["samples"]
 889                         },
 890                         "parameters": []
 891                 }
 892         },
 893         "definitions": {
 894                 "JobResponseHistoryList": {
 895                         "description": "Response History List",
 896                         "type": "object",
 897                         "properties": {
 898                                 "status": {
 899                                         "title": "Status",
 900                                         "description": "Status",
 901                                         "type": "string"
 902                                 },
 903                                 "progress": {
 904                                         "title": "Progress",
 905                                         "description": "Job Progress",
 906                                         "type": "string"
 907                                 },
 908                                 "statusDescription": {
 909                                         "title": "Statusdescription",
 910                                         "description": "Status Description",
 911                                         "type": "string"
 912                                 },
 913                                 "errorCode": {
 914                                         "title": "Errorcode",
 915                                         "description": "Error Code",
 916                                         "type": "string"
 917                                 },
 918                                 "responseId": {
 919                                         "title": "Responseid",
 920                                         "description": "Response Id",
 921                                         "type": "string"
 922                                 }
 923                         }
 924                 },
 925                 "JobResponseDescriptor": {
 926                         "title": "Responsedescriptor",
 927                         "description": "Job Response Descriptor",
 928                         "type": "object",
 929                         "properties": {
 930                                 "status": {
 931                                         "title": "Status",
 932                                         "description": "Status",
 933                                         "type": "string"
 934                                 },
 935                                 "progress": {
 936                                         "title": "Progress",
 937                                         "description": "Job Progress",
 938                                         "type": "string"
 939                                 },
 940                                 "statusDescription": {
 941                                         "title": "Statusdescription",
 942                                         "description": "Status Description",
 943                                         "type": "string"
 944                                 },
 945                                 "errorCode": {
 946                                         "title": "Errorcode",
 947                                         "description": "Error Code",
 948                                         "type": "string"
 949                                 },
 950                                 "responseId": {
 951                                         "title": "Responseid",
 952                                         "description": "Response Id",
 953                                         "type": "string"
 954                                 },
 955                                 "responseHistoryList": {
 956                                         "title": "Responsehistorylist",
 957                                         "description": "Response History List",
 958                                         "type": "array",
 959                                         "items": {
 960                                                 "$ref": "#/definitions/JobResponseHistoryList"
 961                                         }
 962                                 }
 963                         }
 964                 },
 965                 "GetJobResponse": {
 966                         "type": "object",
 967                         "properties": {
 968                                 "jobId": {
 969                                         "title": "Jobid",
 970                                         "description": "Job Id",
 971                                         "type": "string"
 972                                 },
 973                                 "responseDescriptor": {
 974                                         "$ref": "#/definitions/JobResponseDescriptor"
 975                                 }
 976                         }
 977                 },
 978                 "PostJobResponseResult": {
 979                         "required": ["result"],
 980                         "type": "object",
 981                         "properties": {
 982                                 "result": {
 983                                         "title": "Result",
 984                                         "description": "Result",
 985                                         "type": "string"
 986                                 },
 987                                 "msg": {
 988                                         "title": "Msg",
 989                                         "description": "Message",
 990                                         "type": "string"
 991                                 }
 992                         }
 993                 },
 994                 "PostJobRequest": {
 995                         "type": "object",
 996                         "properties": {
 997                                 "progress": {
 998                                         "title": "Progress",
 999                                         "description": "Job Progress",
1000                                         "type": "string"
1001                                 },
1002                                 "desc": {
1003                                         "title": "Desc",
1004                                         "description": "Description",
1005                                         "type": "string"
1006                                 },
1007                                 "errcode": {
1008                                         "title": "Errcode",
1009                                         "description": "Error Code",
1010                                         "type": "string"
1011                                 }
1012                         }
1013                 },
1014                 "NsPackageInfo": {
1015                         "title": "Packageinfo",
1016                         "description": "NS Package Info",
1017                         "type": "object",
1018                         "properties": {
1019                                 "nsdId": {
1020                                         "title": "Nsdid",
1021                                         "description": "NSD ID",
1022                                         "type": "string"
1023                                 },
1024                                 "nsPackageId": {
1025                                         "title": "Nspackageid",
1026                                         "description": "NS Package ID",
1027                                         "type": "string"
1028                                 },
1029                                 "nsdProvider": {
1030                                         "title": "Nsdprovider",
1031                                         "description": "NSD Provider",
1032                                         "type": "string"
1033                                 },
1034                                 "nsdVersion": {
1035                                         "title": "Nsdversion",
1036                                         "description": "NSD Version",
1037                                         "type": "string"
1038                                 },
1039                                 "csarName": {
1040                                         "title": "Csarname",
1041                                         "description": "CSAR name",
1042                                         "type": "string"
1043                                 },
1044                                 "nsdModel": {
1045                                         "title": "Nsdmodel",
1046                                         "description": "NSD Model",
1047                                         "type": "string"
1048                                 },
1049                                 "downloadUrl": {
1050                                         "title": "Downloadurl",
1051                                         "description": "URL to download NSD Model",
1052                                         "type": "string"
1053                                 }
1054                         }
1055                 },
1056                 "NsPackage": {
1057                         "type": "object",
1058                         "properties": {
1059                                 "csarId": {
1060                                         "title": "Csarid",
1061                                         "description": "CSAR ID",
1062                                         "type": "string"
1063                                 },
1064                                 "packageInfo": {
1065                                         "$ref": "#/definitions/NsPackageInfo"
1066                                 }
1067                         }
1068                 },
1069                 "InternalErrorRequest": {
1070                         "required": ["error"],
1071                         "type": "object",
1072                         "properties": {
1073                                 "error": {
1074                                         "title": "Error",
1075                                         "description": "Error",
1076                                         "type": "string"
1077                                 },
1078                                 "errorMessage": {
1079                                         "title": "Errormessage",
1080                                         "description": "Error Message",
1081                                         "type": "string"
1082                                 }
1083                         }
1084                 },
1085                 "NsPackageDistributeRequest": {
1086                         "required": ["csarId"],
1087                         "type": "object",
1088                         "properties": {
1089                                 "csarId": {
1090                                         "title": "Csarid",
1091                                         "description": "csarId",
1092                                         "type": "string"
1093                                 }
1094                         }
1095                 },
1096                 "NsPackageDistributeResponse": {
1097                         "required": ["status", "statusDescription", "errorCode"],
1098                         "type": "object",
1099                         "properties": {
1100                                 "status": {
1101                                         "title": "Status",
1102                                         "description": "status",
1103                                         "type": "string"
1104                                 },
1105                                 "statusDescription": {
1106                                         "title": "Statusdescription",
1107                                         "description": "statusDescription",
1108                                         "type": "string"
1109                                 },
1110                                 "errorCode": {
1111                                         "title": "Errorcode",
1112                                         "description": "errorCode",
1113                                         "type": "string"
1114                                 }
1115                         }
1116                 },
1117                 "ParseModelRequest": {
1118                         "required": ["csarId"],
1119                         "type": "object",
1120                         "properties": {
1121                                 "csarId": {
1122                                         "title": "Csarid",
1123                                         "description": "CSAR ID",
1124                                         "type": "string"
1125                                 },
1126                                 "inputs": {
1127                                         "title": "Inputs",
1128                                         "description": "Inputs",
1129                                         "type": "string"
1130                                 }
1131                         }
1132                 },
1133                 "ParseModelResponse": {
1134                         "required": ["model"],
1135                         "type": "object",
1136                         "properties": {
1137                                 "model": {
1138                                         "title": "Model",
1139                                         "description": "Model",
1140                                         "type": "string"
1141                                 }
1142                         }
1143                 },
1144                 "NfPackageInfo": {
1145                         "title": "Packageinfo",
1146                         "description": "VNF Package Info",
1147                         "required": ["vnfPackageId"],
1148                         "type": "object",
1149                         "properties": {
1150                                 "vnfdId": {
1151                                         "title": "Vnfdid",
1152                                         "description": "VNFD ID",
1153                                         "type": "string"
1154                                 },
1155                                 "vnfPackageId": {
1156                                         "title": "Vnfpackageid",
1157                                         "description": "VNF Package ID",
1158                                         "type": "string"
1159                                 },
1160                                 "vnfdProvider": {
1161                                         "title": "Vnfdprovider",
1162                                         "description": "VNFD Provider",
1163                                         "type": "string"
1164                                 },
1165                                 "vnfdVersion": {
1166                                         "title": "Vnfdversion",
1167                                         "description": "VNFD Version",
1168                                         "type": "string"
1169                                 },
1170                                 "vnfVersion": {
1171                                         "title": "Vnfversion",
1172                                         "description": "VNF Version",
1173                                         "type": "string"
1174                                 },
1175                                 "csarName": {
1176                                         "title": "Csarname",
1177                                         "description": "CSAR Name",
1178                                         "type": "string"
1179                                 },
1180                                 "vnfdModel": {
1181                                         "title": "Vnfdmodel",
1182                                         "description": "VNFD Model",
1183                                         "type": "string"
1184                                 },
1185                                 "downloadUrl": {
1186                                         "title": "Downloadurl",
1187                                         "description": "URL to download VNFD Model",
1188                                         "type": "string"
1189                                 }
1190                         }
1191                 },
1192                 "NfImageInfo": {
1193                         "description": "Image Info",
1194                         "required": ["index", "fileName", "imageId", "vimId", "vimUser", "tenant", "status"],
1195                         "type": "object",
1196                         "properties": {
1197                                 "index": {
1198                                         "title": "Index",
1199                                         "description": "Index of VNF Image",
1200                                         "type": "string"
1201                                 },
1202                                 "fileName": {
1203                                         "title": "Filename",
1204                                         "description": "Image file name",
1205                                         "type": "string"
1206                                 },
1207                                 "imageId": {
1208                                         "title": "Imageid",
1209                                         "description": "Image ID",
1210                                         "type": "string"
1211                                 },
1212                                 "vimId": {
1213                                         "title": "Vimid",
1214                                         "description": "VIM ID",
1215                                         "type": "string"
1216                                 },
1217                                 "vimUser": {
1218                                         "title": "Vimuser",
1219                                         "description": "User of VIM",
1220                                         "type": "string"
1221                                 },
1222                                 "tenant": {
1223                                         "title": "Tenant",
1224                                         "description": "Tenant",
1225                                         "type": "string"
1226                                 },
1227                                 "status": {
1228                                         "title": "Status",
1229                                         "description": "Status",
1230                                         "type": "string"
1231                                 }
1232                         }
1233                 },
1234                 "NfPackage": {
1235                         "required": ["csarId", "packageInfo"],
1236                         "type": "object",
1237                         "properties": {
1238                                 "csarId": {
1239                                         "title": "Csarid",
1240                                         "description": "CSAR ID",
1241                                         "type": "string"
1242                                 },
1243                                 "packageInfo": {
1244                                         "$ref": "#/definitions/NfPackageInfo"
1245                                 },
1246                                 "imageInfo": {
1247                                         "title": "Imageinfo",
1248                                         "description": "Image Info",
1249                                         "type": "array",
1250                                         "items": {
1251                                                 "$ref": "#/definitions/NfImageInfo"
1252                                         }
1253                                 }
1254                         }
1255                 },
1256                 "NfPackageDistributeRequest": {
1257                         "required": ["csarId"],
1258                         "type": "object",
1259                         "properties": {
1260                                 "csarId": {
1261                                         "title": "Csarid",
1262                                         "description": "CSAR ID",
1263                                         "type": "string"
1264                                 },
1265                                 "vimIds": {
1266                                         "title": "Vimids",
1267                                         "description": "A string for vimIds",
1268                                         "type": "array",
1269                                         "items": {
1270                                                 "type": "string"
1271                                         }
1272                                 },
1273                                 "labVimId": {
1274                                         "title": "Labvimid",
1275                                         "description": "A list of VIM IDs.",
1276                                         "type": "string"
1277                                 }
1278                         }
1279                 },
1280                 "PostJobResponse": {
1281                         "required": ["jobId"],
1282                         "type": "object",
1283                         "properties": {
1284                                 "jobId": {
1285                                         "title": "Jobid",
1286                                         "description": "jobId",
1287                                         "type": "string"
1288                                 }
1289                         }
1290                 },
1291                 "ProblemDetails": {
1292                         "title": "Onboardingfailuredetails",
1293                         "description": "Failure details of current onboarding procedure.         It shall be present when the \"nsdOnboardingState\" attribute is CREATED and the uploading or processing fails in NFVO.",
1294                         "required": ["title", "detail"],
1295                         "type": "object",
1296                         "properties": {
1297                                 "type": {
1298                                         "title": "Type",
1299                                         "description": "A URI reference according to IETF RFC 3986 [10] that identifies the problem type.         It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced.         When this member is not present, its value is assumed to be \"about:blank\".",
1300                                         "type": "string"
1301                                 },
1302                                 "title": {
1303                                         "title": "Title",
1304                                         "description": "The HTTP status code for this occurrence of the problem.",
1305                                         "type": "integer"
1306                                 },
1307                                 "detail": {
1308                                         "title": "Detail",
1309                                         "description": "A human-readable explanation specific to this occurrence of the problem.",
1310                                         "type": "string"
1311                                 },
1312                                 "instance": {
1313                                         "title": "Instance",
1314                                         "description": "A URI reference that identifies the specific occurrence of the problem.         It may yield further information if dereferenced.",
1315                                         "type": "string"
1316                                 },
1317                                 "additional_attributes": {
1318                                         "title": "Additional attributes",
1319                                         "description": "Any number of additional attributes, as defined in a specification or by an implementation.",
1320                                         "type": "object",
1321                                         "additionalProperties": {
1322                                                 "description": "Additional attribute",
1323                                                 "type": "string"
1324                                         }
1325                                 }
1326                         }
1327                 },
1328                 "Link": {
1329                         "title": "Self",
1330                         "description": "URI of this resource.",
1331                         "required": ["href"],
1332                         "type": "object",
1333                         "properties": {
1334                                 "href": {
1335                                         "title": "Href",
1336                                         "description": "URI of the referenced resource",
1337                                         "type": "string"
1338                                 }
1339                         }
1340                 },
1341                 "_Link": {
1342                         "title": " links",
1343                         "description": "Links to resources related to this resource.",
1344                         "required": ["self", "nsd_content"],
1345                         "type": "object",
1346                         "properties": {
1347                                 "self": {
1348                                         "$ref": "#/definitions/Link"
1349                                 },
1350                                 "nsd_content": {
1351                                         "$ref": "#/definitions/Link"
1352                                 }
1353                         }
1354                 },
1355                 "NsdInfo": {
1356                         "required": ["id", "nsdOnboardingState", "nsdOperationalState", "nsdUsageState", "_links"],
1357                         "type": "object",
1358                         "properties": {
1359                                 "id": {
1360                                         "title": "Id",
1361                                         "description": "Identifier of the onboarded individual NS descriptor resource.         This identifier is allocated by the NFVO.",
1362                                         "type": "string"
1363                                 },
1364                                 "nsdId": {
1365                                         "title": "Nsdid",
1366                                         "description": "This identifier, which is allocated by the NSD designer,         identifies the NSD in a globally unique way.         It is copied from the NSD content and shall be present after the NSD content is on-boarded.",
1367                                         "type": "string"
1368                                 },
1369                                 "nsdName": {
1370                                         "title": "Nsdname",
1371                                         "description": "Name of the onboarded NSD.         This information is copied from the NSD content and shall be present after the NSD content is on-boarded.",
1372                                         "type": "string"
1373                                 },
1374                                 "nsdVersion": {
1375                                         "title": "Nsdversion",
1376                                         "description": "Version of the on-boarded NSD.         This information is copied from the NSD content and shall be present after the NSD content is on-boarded.",
1377                                         "type": "string"
1378                                 },
1379                                 "nsdDesigner": {
1380                                         "title": "Nsddesigner",
1381                                         "description": "Designer of the on-boarded NSD.         This information is copied from the NSD content and shall be present after the NSD content is on-boarded.",
1382                                         "type": "string"
1383                                 },
1384                                 "nsdInvariantId": {
1385                                         "title": "Nsdinvariantid",
1386                                         "description": "This identifier, which is allocated by the NSD designer,         identifies an NSD in a version independent manner.         This information is copied from the NSD content and shall be present after the NSD content is on-boarded.",
1387                                         "type": "string"
1388                                 },
1389                                 "vnfPkgIds": {
1390                                         "title": "Vnfpkgids",
1391                                         "description": "Identifies the VNF package for the VNFD referenced by the on-boarded NS descriptor resource.",
1392                                         "type": "array",
1393                                         "items": {
1394                                                 "description": "Identifier of the VNF package",
1395                                                 "type": "string"
1396                                         }
1397                                 },
1398                                 "pnfdInfoIds": {
1399                                         "title": "Pnfdinfoids",
1400                                         "description": "Identifies the PnfdInfo element for the PNFD referenced by the on-boarded NS descriptor resource.",
1401                                         "type": "array",
1402                                         "items": {
1403                                                 "description": "Identifier of the PnfdInfo element",
1404                                                 "type": "string"
1405                                         }
1406                                 },
1407                                 "nestedNsdInfoIds": {
1408                                         "title": "Nestednsdinfoids",
1409                                         "description": "Identifies the NsdInfo element for the nested NSD referenced by the on-boarded NS descriptor resource.",
1410                                         "type": "array",
1411                                         "items": {
1412                                                 "description": "Identifier of the NsdInfo element",
1413                                                 "type": "string"
1414                                         }
1415                                 },
1416                                 "nsdOnboardingState": {
1417                                         "title": "Nsdonboardingstate",
1418                                         "description": "Onboarding state of the individual NS descriptor resource.",
1419                                         "type": "string",
1420                                         "enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED"]
1421                                 },
1422                                 "onboardingFailureDetails": {
1423                                         "$ref": "#/definitions/ProblemDetails"
1424                                 },
1425                                 "nsdOperationalState": {
1426                                         "title": "Nsdoperationalstate",
1427                                         "description": "Operational state of the individual NS descriptor resource.         This attribute can be modified with the PATCH method.",
1428                                         "type": "string",
1429                                         "enum": ["ENABLED", "DISABLED"]
1430                                 },
1431                                 "nsdUsageState": {
1432                                         "title": "Nsdusagestate",
1433                                         "description": "Usage state of the individual NS descriptor resource.",
1434                                         "type": "string",
1435                                         "enum": ["IN_USE", "NOT_IN_USE"]
1436                                 },
1437                                 "userDefinedData": {
1438                                         "title": "Userdefineddata",
1439                                         "description": "User defined data for the individual NS descriptor resource.         This attribute can be modified with the PATCH method.",
1440                                         "type": "object",
1441                                         "additionalProperties": {
1442                                                 "description": "Key Value Pairs",
1443                                                 "type": "string"
1444                                         }
1445                                 },
1446                                 "_links": {
1447                                         "$ref": "#/definitions/_Link"
1448                                 }
1449                         }
1450                 },
1451                 "CreateNsdInfoRequest": {
1452                         "type": "object",
1453                         "properties": {
1454                                 "userDefinedData": {
1455                                         "title": "Userdefineddata",
1456                                         "description": "User-defined data for the NS descriptor resource to be created.         It shall be present when the user defined data is set for the individual NS descriptor resource to be created.",
1457                                         "type": "object",
1458                                         "additionalProperties": {
1459                                                 "description": "Key Value Pairs",
1460                                                 "type": "string"
1461                                         }
1462                                 }
1463                         }
1464                 },
1465                 "PnfdInfo": {
1466                         "required": ["id", "pnfdOnboardingState", "pnfdUsageState", "_links"],
1467                         "type": "object",
1468                         "properties": {
1469                                 "id": {
1470                                         "title": "Id",
1471                                         "description": "Identifier of the onboarded individual PNF descriptor resource.         This identifier is allocated by the NFVO.",
1472                                         "type": "string"
1473                                 },
1474                                 "pnfdId": {
1475                                         "title": "Pnfdid",
1476                                         "description": "This identifier, which is allocated by the PNFD designer,         identifies the PNFD in a globally unique way.         It is copied from the PNFD content and shall be present after the PNFD content is on-boarded.",
1477                                         "type": "string"
1478                                 },
1479                                 "pnfdName": {
1480                                         "title": "Pnfdname",
1481                                         "description": "Name of the onboarded PNFD.         This information is copied from the PNFD content and shall be present after the PNFD content is on-boarded.",
1482                                         "type": "string"
1483                                 },
1484                                 "pnfdVersion": {
1485                                         "title": "Pnfdversion",
1486                                         "description": "Version of the on-boarded PNFD.         This information is copied from the PNFD content and shall be present after the PNFD content is on-boarded.",
1487                                         "type": "string"
1488                                 },
1489                                 "pnfdProvider": {
1490                                         "title": "Pnfdprovider",
1491                                         "description": "Provider of the on-boarded PNFD.         This information is copied from the PNFD content and shall be present after the PNFD content is on-boarded.",
1492                                         "type": "string"
1493                                 },
1494                                 "pnfdInvariantId": {
1495                                         "title": "Pnfdinvariantid",
1496                                         "description": "Identifies a PNFD in a version independent manner.         This attribute is invariant across versions of PNFD.",
1497                                         "type": "string"
1498                                 },
1499                                 "pnfdOnboardingState": {
1500                                         "title": "Pnfdonboardingstate",
1501                                         "description": "Onboarding state of the individual PNF descriptor resource.",
1502                                         "type": "string",
1503                                         "enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED"]
1504                                 },
1505                                 "onboardingFailureDetails": {
1506                                         "$ref": "#/definitions/ProblemDetails"
1507                                 },
1508                                 "pnfdUsageState": {
1509                                         "title": "Pnfdusagestate",
1510                                         "description": "Usage state of the individual PNF descriptor resource.",
1511                                         "type": "string",
1512                                         "enum": ["IN_USE", "NOT_IN_USE"]
1513                                 },
1514                                 "userDefinedData": {
1515                                         "title": "Userdefineddata",
1516                                         "description": "User defined data for the individual PNF descriptor resource.         This attribute can be modified with the PATCH method.",
1517                                         "type": "object",
1518                                         "additionalProperties": {
1519                                                 "description": "Key Value Pairs",
1520                                                 "type": "string"
1521                                         }
1522                                 },
1523                                 "_links": {
1524                                         "$ref": "#/definitions/_Link"
1525                                 }
1526                         }
1527                 },
1528                 "CreatePnfdInfoRequest": {
1529                         "type": "object",
1530                         "properties": {
1531                                 "userDefinedData": {
1532                                         "title": "Userdefineddata",
1533                                         "description": "User-defined data for the PNF descriptor resource to be created.         It shall be present when the user defined data is set for the individual PNF descriptor resource to be created.",
1534                                         "type": "object",
1535                                         "additionalProperties": {
1536                                                 "description": "Key Value Pairs",
1537                                                 "type": "string"
1538                                         }
1539                                 }
1540                         }
1541                 },
1542                 "Checksum": {
1543                         "title": "Checksum",
1544                         "description": "Checksum of the on-boarded VNF package.",
1545                         "required": ["algorithm", "hash"],
1546                         "type": "object",
1547                         "properties": {
1548                                 "algorithm": {
1549                                         "title": "Algorithm",
1550                                         "description": "Name of the algorithm used to generate the checksum.",
1551                                         "type": "string"
1552                                 },
1553                                 "hash": {
1554                                         "title": "Hash",
1555                                         "description": "The hexadecimal value of the checksum.",
1556                                         "type": "string"
1557                                 }
1558                         }
1559                 },
1560                 "VnfPackageSoftwareImageInfo": {
1561                         "description": "Information about VNF package artifacts that are software images.",
1562                         "required": ["id", "name", "provider", "version", "checksum", "containerFormat", "diskFormat", "createdAt", "minDisk", "minRam", "size", "imagePath"],
1563                         "type": "object",
1564                         "properties": {
1565                                 "id": {
1566                                         "title": "Id",
1567                                         "description": "Identifier of the software image.",
1568                                         "type": "string"
1569                                 },
1570                                 "name": {
1571                                         "title": "Name",
1572                                         "description": "Name of the software image.",
1573                                         "type": "string"
1574                                 },
1575                                 "provider": {
1576                                         "title": "Provider",
1577                                         "description": "Provider of the software image.",
1578                                         "type": "string"
1579                                 },
1580                                 "version": {
1581                                         "title": "Version",
1582                                         "description": "Version of the software image.",
1583                                         "type": "string"
1584                                 },
1585                                 "checksum": {
1586                                         "$ref": "#/definitions/Checksum"
1587                                 },
1588                                 "containerFormat": {
1589                                         "title": "Containerformat",
1590                                         "description": "terminationType: Indicates whether forceful or graceful termination is requested.",
1591                                         "type": "string",
1592                                         "enum": ["AKI", "AMI", "ARI", "BARE", "DOCKER", "OVA", "OVF"]
1593                                 },
1594                                 "diskFormat": {
1595                                         "title": "Diskformat",
1596                                         "description": "Disk format of a software image is the format of the underlying disk image.",
1597                                         "type": "string",
1598                                         "enum": ["AKI", "AMI", "ARI", "ISO", "QCOW2", "RAW", "VDI", "VHD", "VHDX", "VMDK"]
1599                                 },
1600                                 "createdAt": {
1601                                         "title": "Createdat",
1602                                         "description": "Time when this software image was created.",
1603                                         "type": "string",
1604                                         "format": "date-time"
1605                                 },
1606                                 "minDisk": {
1607                                         "title": "Mindisk",
1608                                         "description": "The minimal disk for this software image in bytes.",
1609                                         "type": "integer"
1610                                 },
1611                                 "minRam": {
1612                                         "title": "Minram",
1613                                         "description": "The minimal RAM for this software image in bytes.",
1614                                         "type": "integer"
1615                                 },
1616                                 "size": {
1617                                         "title": "Size",
1618                                         "description": "Size of this software image in bytes.",
1619                                         "type": "integer"
1620                                 },
1621                                 "userMetadata": {
1622                                         "title": "Usermetadata",
1623                                         "description": "User-defined data.",
1624                                         "type": "object",
1625                                         "additionalProperties": {
1626                                                 "description": "KeyValue Pairs",
1627                                                 "type": "string"
1628                                         }
1629                                 },
1630                                 "imagePath": {
1631                                         "title": "Imagepath",
1632                                         "description": "Path in the VNF package.",
1633                                         "type": "string"
1634                                 }
1635                         }
1636                 },
1637                 "VnfPackageArtifactInfo": {
1638                         "description": "Information about VNF package artifacts contained in the VNF package that are not software images.",
1639                         "required": ["artifactPath", "checksum"],
1640                         "type": "object",
1641                         "properties": {
1642                                 "artifactPath": {
1643                                         "title": "Artifactpath",
1644                                         "description": "Path in the VNF package.",
1645                                         "type": "string"
1646                                 },
1647                                 "checksum": {
1648                                         "$ref": "#/definitions/Checksum"
1649                                 },
1650                                 "metadata": {
1651                                         "title": "Metadata",
1652                                         "description": "The metadata of the artifact that are available in the VNF package",
1653                                         "type": "object",
1654                                         "additionalProperties": {
1655                                                 "description": "KeyValue Pairs",
1656                                                 "type": "string"
1657                                         }
1658                                 }
1659                         }
1660                 },
1661                 "VnfPkgInfo": {
1662                         "required": ["id", "onboardingState", "operationalState", "usageState", "_links"],
1663                         "type": "object",
1664                         "properties": {
1665                                 "id": {
1666                                         "title": "Id",
1667                                         "description": "Identifier of the on-boarded VNF package.",
1668                                         "type": "string"
1669                                 },
1670                                 "vnfdId": {
1671                                         "title": "Vnfdid",
1672                                         "description": "This identifier, which is managed by the VNF provider, identifies the VNF package         and the VNFD in a globally unique way.",
1673                                         "type": "string"
1674                                 },
1675                                 "vnfProvider": {
1676                                         "title": "Vnfprovider",
1677                                         "description": "Provider of the VNF package and the VNFD.",
1678                                         "type": "string"
1679                                 },
1680                                 "vnfProductName": {
1681                                         "title": "Vnfproductname",
1682                                         "description": "Name to identify the VNF product.",
1683                                         "type": "string"
1684                                 },
1685                                 "vnfSoftwareVersion": {
1686                                         "title": "Vnfsoftwareversion",
1687                                         "description": "Software version of the VNF.",
1688                                         "type": "string"
1689                                 },
1690                                 "vnfdVersion": {
1691                                         "title": "Vnfdversion",
1692                                         "description": "The version of the VNvFD.",
1693                                         "type": "string"
1694                                 },
1695                                 "checksum": {
1696                                         "$ref": "#/definitions/Checksum"
1697                                 },
1698                                 "softwareImages": {
1699                                         "title": "Softwareimages",
1700                                         "description": "Information about VNF package artifacts that are software images.",
1701                                         "type": "array",
1702                                         "items": {
1703                                                 "$ref": "#/definitions/VnfPackageSoftwareImageInfo"
1704                                         }
1705                                 },
1706                                 "additionalArtifacts": {
1707                                         "title": "Additionalartifacts",
1708                                         "description": "Information about VNF package artifacts contained in the VNF package that are not software images.",
1709                                         "type": "array",
1710                                         "items": {
1711                                                 "$ref": "#/definitions/VnfPackageArtifactInfo"
1712                                         }
1713                                 },
1714                                 "onboardingState": {
1715                                         "title": "Onboardingstate",
1716                                         "description": "On-boarding state of the VNF package.",
1717                                         "type": "string",
1718                                         "enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED"]
1719                                 },
1720                                 "operationalState": {
1721                                         "title": "Operationalstate",
1722                                         "description": "Operational state of the VNF package.",
1723                                         "type": "string",
1724                                         "enum": ["ENABLED", "DISABLED"]
1725                                 },
1726                                 "usageState": {
1727                                         "title": "Usagestate",
1728                                         "description": "Usage state of the VNF package.",
1729                                         "type": "string",
1730                                         "enum": ["IN_USE", "NOT_IN_USE"]
1731                                 },
1732                                 "userDefinedData": {
1733                                         "title": "Userdefineddata",
1734                                         "description": "User defined data for the VNF package.",
1735                                         "type": "object",
1736                                         "additionalProperties": {
1737                                                 "description": "KeyValue Pairs",
1738                                                 "type": "string"
1739                                         }
1740                                 },
1741                                 "_links": {
1742                                         "$ref": "#/definitions/_Link"
1743                                 }
1744                         }
1745                 },
1746                 "CreateVnfPkgInfoRequest": {
1747                         "type": "object",
1748                         "properties": {
1749                                 "userDefinedData": {
1750                                         "title": "Userdefineddata",
1751                                         "description": "User defined data for the VNF package.",
1752                                         "type": "object",
1753                                         "additionalProperties": {
1754                                                 "description": "KeyValue Pairs",
1755                                                 "type": "string"
1756                                         }
1757                                 }
1758                         }
1759                 },
1760                 "UploadVnfPackageFromUriRequest": {
1761                         "required": ["addressInformation"],
1762                         "type": "object",
1763                         "properties": {
1764                                 "addressInformation": {
1765                                         "title": "Addressinformation",
1766                                         "description": "Address information of the VNF package content.",
1767                                         "type": "string"
1768                                 },
1769                                 "userName": {
1770                                         "title": "Username",
1771                                         "description": "User name to be used for authentication.",
1772                                         "type": "string"
1773                                 },
1774                                 "password": {
1775                                         "title": "Password",
1776                                         "description": "Password to be used for authentication.",
1777                                         "type": "string"
1778                                 }
1779                         }
1780                 }
1781         },
1782         "securityDefinitions": {
1783                 "basic": {
1784                         "type": "basic"
1785                 }
1786         }
1787 }