docs/swagger/etsicatalog_API_v1.yaml

   1 swagger: '2.0'
   2 info:
   3   title: Modeling etsicatalog API
   4   description: "\n\nThe `swagger-ui` view can be found [here](/api/catalog/v1/swagger).\n\
   5     The `ReDoc` view can be found [here](/api/catalog/v1/redoc).\nThe swagger YAML\
   6     \ document can be found [here](/api/catalog/v1/swagger.yaml).\nThe swagger JSON\
   7     \ document can be found [here](/api/catalog/v1/swagger.json)."
   8   version: v1
   9 host: 127.0.0.1:8806
  10 schemes:
  11   - http
  12 basePath: /
  13 consumes:
  14   - application/json
  15 produces:
  16   - application/json
  17 securityDefinitions:
  18   Basic:
  19     type: basic
  20 security:
  21   - Basic: []
  22 paths:
  23   /api/catalog/v1/nspackages:
  24     get:
  25       operationId: api_catalog_v1_nspackages_list
  26       description: Query NS packages
  27       parameters: []
  28       responses:
  29         '200':
  30           description: ''
  31           schema:
  32             type: array
  33             items:
  34               $ref: '#/definitions/NsPackage'
  35         '500':
  36           description: ''
  37           schema:
  38             $ref: '#/definitions/InternalErrorRequest'
  39       tags:
  40         - Catalog interface
  41     post:
  42       operationId: api_catalog_v1_nspackages_create
  43       description: On distribute NS package
  44       parameters:
  45         - name: data
  46           in: body
  47           required: true
  48           schema:
  49             $ref: '#/definitions/NsPackageDistributeRequest'
  50       responses:
  51         '202':
  52           description: ''
  53           schema:
  54             $ref: '#/definitions/NsPackageDistributeResponse'
  55         '500':
  56           description: ''
  57           schema:
  58             $ref: '#/definitions/InternalErrorRequest'
  59       tags:
  60         - Catalog interface
  61     parameters: []
  62   /api/catalog/v1/nspackages/{csarId}:
  63     get:
  64       operationId: api_catalog_v1_nspackages_read
  65       description: Query one NS package
  66       parameters:
  67         - name: csarId
  68           in: query
  69           description: csarId
  70           type: string
  71       responses:
  72         '200':
  73           description: ''
  74           schema:
  75             $ref: '#/definitions/NsPackage'
  76         '500':
  77           description: error message
  78           schema:
  79             type: string
  80       tags:
  81         - Catalog interface
  82     delete:
  83       operationId: api_catalog_v1_nspackages_delete
  84       description: Delete one NS package
  85       parameters:
  86         - name: csarId
  87           in: query
  88           description: csarId
  89           type: string
  90       responses:
  91         '200':
  92           description: ''
  93           schema:
  94             $ref: '#/definitions/NsPackageDistributeResponse'
  95         '500':
  96           description: error message
  97           schema:
  98             type: string
  99       tags:
 100         - Catalog interface
 101     parameters:
 102       - name: csarId
 103         in: path
 104         required: true
 105         type: string
 106   /api/catalog/v1/service_packages:
 107     get:
 108       operationId: api_catalog_v1_service_packages_list
 109       description: Query Service packages
 110       parameters: []
 111       responses:
 112         '200':
 113           description: ''
 114           schema:
 115             type: array
 116             items:
 117               $ref: '#/definitions/ServicePackage'
 118         '500':
 119           description: ''
 120           schema:
 121             $ref: '#/definitions/InternalErrorRequest'
 122       tags:
 123         - Catalog interface
 124     post:
 125       operationId: api_catalog_v1_service_packages_create
 126       description: On distribute Service package
 127       parameters:
 128         - name: data
 129           in: body
 130           required: true
 131           schema:
 132             $ref: '#/definitions/ServicePackageDistributeRequest'
 133       responses:
 134         '202':
 135           description: ''
 136         '400':
 137           description: ''
 138           schema:
 139             $ref: '#/definitions/InternalErrorRequest'
 140         '500':
 141           description: ''
 142           schema:
 143             $ref: '#/definitions/InternalErrorRequest'
 144       tags:
 145         - Catalog interface
 146     parameters: []
 147   /api/catalog/v1/service_packages/{csarId}:
 148     get:
 149       operationId: api_catalog_v1_service_packages_read
 150       description: Query one Service package
 151       parameters:
 152         - name: csarId
 153           in: query
 154           description: csarId
 155           type: string
 156       responses:
 157         '200':
 158           description: ''
 159           schema:
 160             $ref: '#/definitions/ServicePackage'
 161         '404':
 162           description: ''
 163           schema:
 164             $ref: '#/definitions/InternalErrorRequest'
 165         '500':
 166           description: ''
 167           schema:
 168             $ref: '#/definitions/InternalErrorRequest'
 169       tags:
 170         - Catalog interface
 171     delete:
 172       operationId: api_catalog_v1_service_packages_delete
 173       description: Delete one Service package
 174       parameters:
 175         - name: csarId
 176           in: query
 177           description: csarId
 178           type: string
 179       responses:
 180         '204':
 181           description: ''
 182         '404':
 183           description: ''
 184           schema:
 185             $ref: '#/definitions/InternalErrorRequest'
 186         '500':
 187           description: ''
 188           schema:
 189             $ref: '#/definitions/InternalErrorRequest'
 190       tags:
 191         - Catalog interface
 192     parameters:
 193       - name: csarId
 194         in: path
 195         required: true
 196         type: string
 197   /api/catalog/v1/vnfpackages:
 198     get:
 199       operationId: api_catalog_v1_vnfpackages_list
 200       description: Query Nf packages
 201       parameters: []
 202       responses:
 203         '200':
 204           description: ''
 205           schema:
 206             type: array
 207             items:
 208               $ref: '#/definitions/NfPackage'
 209         '500':
 210           description: ''
 211           schema:
 212             $ref: '#/definitions/InternalErrorRequest'
 213       tags:
 214         - Catalog interface
 215     post:
 216       operationId: api_catalog_v1_vnfpackages_create
 217       description: On distribute Nf package
 218       parameters:
 219         - name: data
 220           in: body
 221           required: true
 222           schema:
 223             $ref: '#/definitions/NfPackageDistributeRequest'
 224       responses:
 225         '202':
 226           description: ''
 227           schema:
 228             $ref: '#/definitions/PostJobResponse'
 229         '500':
 230           description: ''
 231           schema:
 232             $ref: '#/definitions/InternalErrorRequest'
 233       tags:
 234         - Catalog interface
 235     parameters: []
 236   /api/catalog/v1/vnfpackages/{csarId}:
 237     get:
 238       operationId: api_catalog_v1_vnfpackages_read
 239       description: Query one Nf package
 240       parameters:
 241         - name: csarId
 242           in: query
 243           description: csarId
 244           type: string
 245       responses:
 246         '200':
 247           description: ''
 248           schema:
 249             $ref: '#/definitions/NfPackage'
 250         '500':
 251           description: error message
 252           schema:
 253             type: string
 254       tags:
 255         - Catalog interface
 256     delete:
 257       operationId: api_catalog_v1_vnfpackages_delete
 258       description: Delete one Nf package
 259       parameters:
 260         - name: csarId
 261           in: query
 262           description: csarId
 263           type: string
 264       responses:
 265         '202':
 266           description: ''
 267           schema:
 268             $ref: '#/definitions/PostJobResponse'
 269         '500':
 270           description: error message
 271           schema:
 272             type: string
 273       tags:
 274         - Catalog interface
 275     parameters:
 276       - name: csarId
 277         in: path
 278         required: true
 279         type: string
 280   /api/nsd/v1/health_check:
 281     get:
 282       operationId: api_nsd_v1_health_check_list
 283       description: ''
 284       parameters: []
 285       responses:
 286         '200':
 287           description: Active
 288       tags:
 289         - Health Check interface
 290     parameters: []
 291   /api/nsd/v1/ns_descriptors:
 292     get:
 293       operationId: api_nsd_v1_ns_descriptors_list
 294       description: Query multiple NSDs
 295       parameters: []
 296       responses:
 297         '200':
 298           description: ''
 299           schema:
 300             type: array
 301             items:
 302               $ref: '#/definitions/NsdInfo'
 303         '500':
 304           description: Internal error
 305       tags:
 306         - NSD Management interface
 307     post:
 308       operationId: api_nsd_v1_ns_descriptors_create
 309       description: Create a NSD
 310       parameters:
 311         - name: data
 312           in: body
 313           required: true
 314           schema:
 315             $ref: '#/definitions/CreateNsdInfoRequest'
 316       responses:
 317         '201':
 318           description: ''
 319           schema:
 320             $ref: '#/definitions/NsdInfo'
 321         '500':
 322           description: Internal error
 323       tags:
 324         - NSD Management interface
 325     parameters: []
 326   /api/nsd/v1/ns_descriptors/{nsdInfoId}:
 327     get:
 328       operationId: api_nsd_v1_ns_descriptors_read
 329       description: Query a NSD
 330       parameters: []
 331       responses:
 332         '200':
 333           description: ''
 334           schema:
 335             $ref: '#/definitions/NsdInfo'
 336         '404':
 337           description: NSDs do not exist
 338         '500':
 339           description: Internal error
 340       tags:
 341         - NSD Management interface
 342     delete:
 343       operationId: api_nsd_v1_ns_descriptors_delete
 344       description: Delete a NSD
 345       parameters: []
 346       responses:
 347         '204':
 348           description: No content
 349         '500':
 350           description: Internal error
 351       tags:
 352         - NSD Management interface
 353     parameters:
 354       - name: nsdInfoId
 355         in: path
 356         required: true
 357         type: string
 358   /api/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content:
 359     get:
 360       operationId: api_nsd_v1_ns_descriptors_nsd_content_list
 361       description: Download NSD content
 362       parameters: []
 363       responses:
 364         '204':
 365           description: No content
 366         '404':
 367           description: NSD does not exist.
 368         '500':
 369           description: Internal error
 370       tags:
 371         - NSD Management interface
 372     put:
 373       operationId: api_nsd_v1_ns_descriptors_nsd_content_update
 374       description: Upload NSD content
 375       parameters: []
 376       responses:
 377         '204':
 378           description: PNFD file
 379         '500':
 380           description: Internal error
 381       tags:
 382         - NSD Management interface
 383     parameters:
 384       - name: nsdInfoId
 385         in: path
 386         required: true
 387         type: string
 388   /api/nsd/v1/pnf_descriptors:
 389     get:
 390       operationId: api_nsd_v1_pnf_descriptors_list
 391       description: Query multiple PNFDs
 392       parameters: []
 393       responses:
 394         '200':
 395           description: ''
 396           schema:
 397             type: array
 398             items:
 399               $ref: '#/definitions/PnfdInfo'
 400         '500':
 401           description: ''
 402           schema:
 403             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 404       tags:
 405         - NSD Management interface
 406     post:
 407       operationId: api_nsd_v1_pnf_descriptors_create
 408       description: Create a  PNFD
 409       parameters:
 410         - name: data
 411           in: body
 412           required: true
 413           schema:
 414             $ref: '#/definitions/CreatePnfdInfoRequest'
 415       responses:
 416         '201':
 417           description: ''
 418           schema:
 419             $ref: '#/definitions/PnfdInfo'
 420         '500':
 421           description: ''
 422           schema:
 423             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 424       tags:
 425         - NSD Management interface
 426     parameters: []
 427   /api/nsd/v1/pnf_descriptors/{pnfdInfoId}:
 428     get:
 429       operationId: api_nsd_v1_pnf_descriptors_read
 430       description: Query a PNFD
 431       parameters: []
 432       responses:
 433         '200':
 434           description: ''
 435           schema:
 436             $ref: '#/definitions/PnfdInfo'
 437         '404':
 438           description: ''
 439           schema:
 440             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 441         '500':
 442           description: ''
 443           schema:
 444             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 445       tags:
 446         - NSD Management interface
 447     delete:
 448       operationId: api_nsd_v1_pnf_descriptors_delete
 449       description: Delete a PNFD
 450       parameters: []
 451       responses:
 452         '204':
 453           description: No content
 454         '500':
 455           description: ''
 456           schema:
 457             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 458       tags:
 459         - NSD Management interface
 460     parameters:
 461       - name: pnfdInfoId
 462         in: path
 463         required: true
 464         type: string
 465   /api/nsd/v1/pnf_descriptors/{pnfdInfoId}/pnfd_content:
 466     get:
 467       operationId: Fetch PNFD content
 468       description: Fetch PNFD content
 469       parameters: []
 470       responses:
 471         '200':
 472           description: PNFD file
 473           schema:
 474             type: string
 475             format: binary
 476         '404':
 477           description: ''
 478           schema:
 479             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 480         '500':
 481           description: ''
 482           schema:
 483             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 484       produces:
 485         - application/octet-stream
 486         - application/json
 487       tags:
 488         - NSD Management interface
 489     put:
 490       operationId: api_nsd_v1_pnf_descriptors_pnfd_content_update
 491       description: Upload PNFD content
 492       parameters: []
 493       responses:
 494         '204':
 495           description: No content
 496         '500':
 497           description: ''
 498           schema:
 499             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 500       tags:
 501         - NSD Management interface
 502     parameters:
 503       - name: pnfdInfoId
 504         in: path
 505         required: true
 506         type: string
 507   /api/nsd/v1/subscriptions:
 508     get:
 509       operationId: api_nsd_v1_subscriptions_list
 510       description: Query subscriptions for Nsd Management
 511       parameters: []
 512       responses:
 513         '200':
 514           description: ''
 515           schema:
 516             type: array
 517             items:
 518               $ref: '#/definitions/NsdmSubscription'
 519         '400':
 520           description: ''
 521           schema:
 522             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 523         '404':
 524           description: ''
 525           schema:
 526             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 527         '500':
 528           description: ''
 529           schema:
 530             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 531       tags:
 532         - NSD Management interface
 533     post:
 534       operationId: api_nsd_v1_subscriptions_create
 535       description: Create Subscription for NSD Management
 536       parameters:
 537         - name: data
 538           in: body
 539           required: true
 540           schema:
 541             $ref: '#/definitions/NsdmSubscriptionRequest'
 542       responses:
 543         '201':
 544           description: ''
 545           schema:
 546             $ref: '#/definitions/NsdmSubscription'
 547         '303':
 548           description: ''
 549           schema:
 550             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 551         '400':
 552           description: ''
 553           schema:
 554             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 555         '500':
 556           description: ''
 557           schema:
 558             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 559       tags:
 560         - NSD Management interface
 561     parameters: []
 562   /api/nsd/v1/subscriptions/{subscriptionId}:
 563     get:
 564       operationId: api_nsd_v1_subscriptions_read
 565       description: Query subscriptions for Nsd Management
 566       parameters: []
 567       responses:
 568         '200':
 569           description: ''
 570           schema:
 571             $ref: '#/definitions/NsdmSubscription'
 572         '400':
 573           description: ''
 574           schema:
 575             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 576         '404':
 577           description: ''
 578           schema:
 579             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 580         '500':
 581           description: ''
 582           schema:
 583             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 584       tags:
 585         - NSD Management interface
 586     delete:
 587       operationId: api_nsd_v1_subscriptions_delete
 588       description: Delete subscription for Nsd Management
 589       parameters: []
 590       responses:
 591         '204':
 592           description: No_Content
 593         '400':
 594           description: ''
 595           schema:
 596             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 597         '404':
 598           description: ''
 599           schema:
 600             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 601         '500':
 602           description: ''
 603           schema:
 604             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 605       tags:
 606         - NSD Management interface
 607     parameters:
 608       - name: subscriptionId
 609         in: path
 610         required: true
 611         type: string
 612   /api/vnfpkgm/v1/health_check:
 613     get:
 614       operationId: api_vnfpkgm_v1_health_check_list
 615       description: ''
 616       parameters: []
 617       responses:
 618         '200':
 619           description: Active
 620       tags:
 621         - Health Check interface
 622     parameters: []
 623   /api/vnfpkgm/v1/subscriptions:
 624     get:
 625       operationId: api_vnfpkgm_v1_subscriptions_list
 626       description: ''
 627       parameters: []
 628       responses:
 629         '200':
 630           description: ''
 631           schema:
 632             $ref: '#/definitions/PkgmSubscription'
 633         '400':
 634           description: ''
 635           schema:
 636             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 637         '500':
 638           description: ''
 639           schema:
 640             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 641       tags:
 642         - VNF Package Management interface
 643     post:
 644       operationId: api_vnfpkgm_v1_subscriptions_create
 645       description: ''
 646       parameters:
 647         - name: data
 648           in: body
 649           required: true
 650           schema:
 651             $ref: '#/definitions/PkgmSubscriptionRequest'
 652       responses:
 653         '201':
 654           description: ''
 655           schema:
 656             $ref: '#/definitions/PkgmSubscription'
 657         '400':
 658           description: ''
 659           schema:
 660             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 661         '500':
 662           description: ''
 663           schema:
 664             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 665       tags:
 666         - VNF Package Management interface
 667     parameters: []
 668   /api/vnfpkgm/v1/subscriptions/{subscriptionId}:
 669     get:
 670       operationId: api_vnfpkgm_v1_subscriptions_read
 671       description: ''
 672       parameters: []
 673       responses:
 674         '200':
 675           description: ''
 676           schema:
 677             $ref: '#/definitions/PkgmSubscription'
 678         '404':
 679           description: ''
 680           schema:
 681             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 682         '500':
 683           description: ''
 684           schema:
 685             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 686       tags:
 687         - VNF Package Management interface
 688     delete:
 689       operationId: api_vnfpkgm_v1_subscriptions_delete
 690       description: ''
 691       parameters: []
 692       responses:
 693         '204':
 694           description: ''
 695         '404':
 696           description: ''
 697           schema:
 698             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 699         '500':
 700           description: ''
 701           schema:
 702             $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
 703       tags:
 704         - VNF Package Management interface
 705     parameters:
 706       - name: subscriptionId
 707         in: path
 708         required: true
 709         type: string
 710   /api/vnfpkgm/v1/vnf_packages:
 711     get:
 712       operationId: api_vnfpkgm_v1_vnf_packages_list
 713       description: Query multiple VNF package resource
 714       parameters: []
 715       responses:
 716         '200':
 717           description: ''
 718           schema:
 719             type: array
 720             items:
 721               $ref: '#/definitions/VnfPkgInfo'
 722         '500':
 723           description: Internal error
 724           schema:
 725             type: string
 726       tags:
 727         - VNF Package Management interface
 728     post:
 729       operationId: api_vnfpkgm_v1_vnf_packages_create
 730       description: Create an individual VNF package resource
 731       parameters:
 732         - name: data
 733           in: body
 734           required: true
 735           schema:
 736             $ref: '#/definitions/CreateVnfPkgInfoRequest'
 737       responses:
 738         '201':
 739           description: ''
 740           schema:
 741             $ref: '#/definitions/VnfPkgInfo'
 742         '400':
 743           description: Bad Request
 744           schema:
 745             type: string
 746         '500':
 747           description: Internal error
 748           schema:
 749             type: string
 750       tags:
 751         - VNF Package Management interface
 752     parameters: []
 753   /api/vnfpkgm/v1/vnf_packages/{vnfPkgId}:
 754     get:
 755       operationId: api_vnfpkgm_v1_vnf_packages_read
 756       description: Query an individual VNF package resource
 757       parameters: []
 758       responses:
 759         '200':
 760           description: ''
 761           schema:
 762             $ref: '#/definitions/VnfPkgInfo'
 763         '404':
 764           description: VNF package does not exist
 765           schema:
 766             type: string
 767         '500':
 768           description: Internal error
 769           schema:
 770             type: string
 771       tags:
 772         - VNF Package Management interface
 773     delete:
 774       operationId: api_vnfpkgm_v1_vnf_packages_delete
 775       description: Delete an individual VNF package resource
 776       parameters: []
 777       responses:
 778         '204':
 779           description: No content
 780         '500':
 781           description: Internal error
 782           schema:
 783             type: string
 784       tags:
 785         - VNF Package Management interface
 786     parameters:
 787       - name: vnfPkgId
 788         in: path
 789         required: true
 790         type: string
 791   /api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}:
 792     get:
 793       operationId: api_vnfpkgm_v1_vnf_packages_artifacts_read
 794       description: ''
 795       parameters: []
 796       responses:
 797         '200':
 798           description: Return the artifact file
 799           schema:
 800             type: string
 801             format: binary
 802         '404':
 803           description: Artifact not found
 804           schema:
 805             type: string
 806         '500':
 807           description: Internal error
 808           schema:
 809             type: string
 810       produces:
 811         - application/octet-stream
 812         - application/json
 813       tags:
 814         - VNF Package Management interface
 815     parameters:
 816       - name: artifactPath
 817         in: path
 818         required: true
 819         type: string
 820       - name: vnfPkgId
 821         in: path
 822         required: true
 823         type: string
 824   /api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content:
 825     get:
 826       operationId: api_vnfpkgm_v1_vnf_packages_package_content_list
 827       description: Fetch VNF package content
 828       parameters: []
 829       responses:
 830         '200':
 831           description: VNF package file
 832           schema:
 833             type: string
 834             format: binary
 835         '404':
 836           description: VNF package does not exist
 837           schema:
 838             type: string
 839         '500':
 840           description: Internal error
 841           schema:
 842             type: string
 843       produces:
 844         - application/octet-stream
 845         - application/json
 846       tags:
 847         - VNF Package Management interface
 848     put:
 849       operationId: api_vnfpkgm_v1_vnf_packages_package_content_update
 850       description: Upload VNF package content
 851       parameters: []
 852       responses:
 853         '202':
 854           description: Successfully
 855         '500':
 856           description: Internal error
 857           schema:
 858             type: string
 859       tags:
 860         - VNF Package Management interface
 861     parameters:
 862       - name: vnfPkgId
 863         in: path
 864         required: true
 865         type: string
 866   /api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content/upload_from_uri:
 867     post:
 868       operationId: api_vnfpkgm_v1_vnf_packages_package_content_upload_from_uri_create
 869       description: Upload VNF package content from uri
 870       parameters:
 871         - name: data
 872           in: body
 873           required: true
 874           schema:
 875             $ref: '#/definitions/UploadVnfPackageFromUriRequest'
 876       responses:
 877         '202':
 878           description: Successfully
 879         '400':
 880           description: Bad Request
 881           schema:
 882             type: string
 883         '500':
 884           description: Internal error
 885           schema:
 886             type: string
 887       tags:
 888         - VNF Package Management interface
 889     parameters:
 890       - name: vnfPkgId
 891         in: path
 892         required: true
 893         type: string
 894   /api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd:
 895     get:
 896       operationId: VNFD of an on-boarded VNF package
 897       description: Read VNFD of an on-boarded VNF package
 898       parameters: []
 899       responses:
 900         '200':
 901           description: VNFD of an on-boarded VNF package
 902           schema:
 903             type: string
 904             format: binary
 905         '404':
 906           description: VNF package does not exist
 907           schema:
 908             type: string
 909         '500':
 910           description: Internal error
 911           schema:
 912             type: string
 913       produces:
 914         - application/octet-stream
 915         - application/json
 916       tags:
 917         - VNF Package Management interface
 918     parameters:
 919       - name: vnfPkgId
 920         in: path
 921         required: true
 922         type: string
 923   /api/parser/v1/health_check:
 924     get:
 925       operationId: api_parser_v1_health_check_list
 926       description: ''
 927       parameters: []
 928       responses:
 929         '200':
 930           description: Active
 931       tags:
 932         - Health Check interface
 933     parameters: []
 934   /api/parser/v1/parser:
 935     post:
 936       operationId: api_parser_v1_parser_create
 937       description: Parse model(NS, Service, VNF, PNF)
 938       parameters:
 939         - name: data
 940           in: body
 941           required: true
 942           schema:
 943             $ref: '#/definitions/ParseModelRequest'
 944       responses:
 945         '202':
 946           description: ''
 947           schema:
 948             $ref: '#/definitions/ParseModelResponse'
 949         '500':
 950           description: ''
 951           schema:
 952             $ref: '#/definitions/InternalErrorRequest'
 953       tags:
 954         - Parser interface
 955     parameters: []
 956   /api/parser/v1/parsernsd:
 957     post:
 958       operationId: api_parser_v1_parsernsd_create
 959       description: Parse NS model
 960       parameters:
 961         - name: data
 962           in: body
 963           required: true
 964           schema:
 965             $ref: '#/definitions/ParseModelRequest'
 966       responses:
 967         '202':
 968           description: ''
 969           schema:
 970             $ref: '#/definitions/ParseModelResponse'
 971         '500':
 972           description: ''
 973           schema:
 974             $ref: '#/definitions/InternalErrorRequest'
 975       tags:
 976         - Parser interface
 977     parameters: []
 978   /api/parser/v1/parserpnfd:
 979     post:
 980       operationId: api_parser_v1_parserpnfd_create
 981       description: Parse PNF model
 982       parameters:
 983         - name: data
 984           in: body
 985           required: true
 986           schema:
 987             $ref: '#/definitions/ParseModelRequest'
 988       responses:
 989         '202':
 990           description: ''
 991           schema:
 992             $ref: '#/definitions/ParseModelResponse'
 993         '500':
 994           description: ''
 995           schema:
 996             $ref: '#/definitions/InternalErrorRequest'
 997       tags:
 998         - Parser interface
 999     parameters: []
1000   /api/parser/v1/parservnfd:
1001     post:
1002       operationId: api_parser_v1_parservnfd_create
1003       description: Parse NF model
1004       parameters:
1005         - name: data
1006           in: body
1007           required: true
1008           schema:
1009             $ref: '#/definitions/ParseModelRequest'
1010       responses:
1011         '202':
1012           description: ''
1013           schema:
1014             $ref: '#/definitions/ParseModelResponse'
1015         '500':
1016           description: ''
1017           schema:
1018             $ref: '#/definitions/InternalErrorRequest'
1019       tags:
1020         - Parser interface
1021     parameters: []
1022   /api/catalog/v1/callback_sample:
1023     get:
1024       operationId: api_catalog_v1_callback_sample_list
1025       description: Callback Sample.
1026       parameters: []
1027       responses:
1028         '200':
1029           description: ''
1030       tags:
1031         - Sample interface
1032     parameters: []
1033   /api/catalog/v1/health_check:
1034     get:
1035       operationId: api_catalog_v1_health_check_list
1036       description: ''
1037       parameters: []
1038       responses:
1039         '200':
1040           description: Active
1041       tags:
1042         - Health Check interface
1043     parameters: []
1044   /api/catalog/v1/jobs/{job_id}:
1045     get:
1046       operationId: api_catalog_v1_jobs_read
1047       description: Get job status
1048       parameters:
1049         - name: job_id
1050           in: query
1051           description: job id
1052           type: string
1053         - name: responseId
1054           in: query
1055           description: response id
1056           type: string
1057       responses:
1058         '200':
1059           description: ''
1060           schema:
1061             $ref: '#/definitions/GetJobResponse'
1062         '500':
1063           description: ''
1064           schema:
1065             $ref: '#/definitions/PostJobResponseResult'
1066       tags:
1067         - Catalog interface
1068     post:
1069       operationId: api_catalog_v1_jobs_create
1070       description: Update job status
1071       parameters:
1072         - name: data
1073           in: body
1074           required: true
1075           schema:
1076             $ref: '#/definitions/PostJobRequest'
1077         - name: job_id
1078           in: query
1079           description: job id
1080           type: string
1081       responses:
1082         '202':
1083           description: ''
1084           schema:
1085             $ref: '#/definitions/PostJobResponseResult'
1086         '500':
1087           description: ''
1088           schema:
1089             $ref: '#/definitions/PostJobResponseResult'
1090       tags:
1091         - Catalog interface
1092     parameters:
1093       - name: job_id
1094         in: path
1095         required: true
1096         type: string
1097   /api/catalog/v1/mandb/{modelName}:
1098     get:
1099       operationId: api_catalog_v1_mandb_read
1100       description: ''
1101       parameters: []
1102       responses:
1103         '200':
1104           description: ''
1105       tags:
1106         - Sample interface
1107     delete:
1108       operationId: api_catalog_v1_mandb_delete
1109       description: ''
1110       parameters: []
1111       responses:
1112         '204':
1113           description: ''
1114       tags:
1115         - Sample interface
1116     parameters:
1117       - name: modelName
1118         in: path
1119         required: true
1120         type: string
1121   /samples/:
1122     get:
1123       operationId: samples_list
1124       description: List all samples.
1125       parameters: []
1126       responses:
1127         '200':
1128           description: ''
1129       tags:
1130         - Sample interface
1131     parameters: []
1132 definitions:
1133   NOTIFICATION_LINKSERIALIZER:
1134     title: Vnfpackage
1135     description: Link to the resource representing the VNF package to which the notified
1136       change applies.
1137     required:
1138       - href
1139     type: object
1140     properties:
1141       href:
1142         title: Href
1143         description: URI of the referenced resource.
1144         type: string
1145         minLength: 1
1146   PkgmLinks:
1147     title: ' links'
1148     description: Links to resources related to this resource.
1149     type: object
1150     properties:
1151       vnfPackage:
1152         $ref: '#/definitions/NOTIFICATION_LINKSERIALIZER'
1153       subscription:
1154         $ref: '#/definitions/NOTIFICATION_LINKSERIALIZER'
1155   PkgChangeNotification:
1156     required:
1157       - id
1158       - notificationType
1159       - timeStamp
1160       - subscriptionId
1161       - vnfPkgId
1162       - changeType
1163       - vnfdId
1164       - _links
1165     type: object
1166     properties:
1167       id:
1168         title: Id
1169         description: Identifier of this notification.
1170         type: string
1171         minLength: 1
1172       notificationType:
1173         title: Notificationtype
1174         description: Discriminator for the different notification types.
1175         type: string
1176         enum:
1177           - VnfPackageChangeNotification
1178       timeStamp:
1179         title: Timestamp
1180         description: Date-time of the generation of the notification.
1181         type: string
1182         format: date-time
1183       subscriptionId:
1184         title: Subscriptionid
1185         description: Identifier of the subscription that this notification relates
1186           to.
1187         type: string
1188         minLength: 1
1189       vnfPkgId:
1190         title: Vnfpkgid
1191         description: Identifier of the VNF package.
1192         type: string
1193         format: uuid
1194       changeType:
1195         title: Changetype
1196         description: The type of change of the VNF package.
1197         type: string
1198         enum:
1199           - OP_STATE_CHANGE
1200           - PKG_DELETE
1201       operationalState:
1202         title: Operationalstate
1203         description: New operational state of the VNF package.
1204         type: string
1205         enum:
1206           - ENABLED
1207           - DISABLED
1208       vnfdId:
1209         title: Vnfdid
1210         description: This identifier, which is managed by the VNF provider, identifies
1211           the VNF package and the VNFD in a globally unique way.
1212         type: string
1213         minLength: 1
1214       _links:
1215         $ref: '#/definitions/PkgmLinks'
1216   PkgOnboardingNotification:
1217     required:
1218       - id
1219       - notificationType
1220       - subscriptionId
1221       - timeStamp
1222       - vnfPkgId
1223       - vnfdId
1224       - _links
1225     type: object
1226     properties:
1227       id:
1228         title: Id
1229         description: Identifier of this notification.
1230         type: string
1231         minLength: 1
1232       notificationType:
1233         title: Notificationtype
1234         description: Discriminator for the different notification types.
1235         type: string
1236         enum:
1237           - VnfPackageOnboardingNotification
1238       subscriptionId:
1239         title: Subscriptionid
1240         description: Identifier of the subscription that this notification relates
1241           to.
1242         type: string
1243         minLength: 1
1244       timeStamp:
1245         title: Timestamp
1246         description: Date-time of the generation of the notification.
1247         type: string
1248         format: date-time
1249       vnfPkgId:
1250         title: Vnfpkgid
1251         description: Identifier of the VNF package.
1252         type: string
1253         format: uuid
1254       vnfdId:
1255         title: Vnfdid
1256         description: This identifier, which is managed by the VNF provider, identifies
1257           the VNF package and the VNFD in a globally unique way.
1258         type: string
1259         format: uuid
1260       _links:
1261         $ref: '#/definitions/PkgmLinks'
1262   JobResponseHistoryList:
1263     description: Response History List
1264     type: object
1265     properties:
1266       status:
1267         title: Status
1268         description: Status
1269         type: string
1270         minLength: 1
1271       progress:
1272         title: Progress
1273         description: Job Progress
1274         type: string
1275         minLength: 1
1276       statusDescription:
1277         title: Statusdescription
1278         description: Status Description
1279         type: string
1280         minLength: 1
1281       errorCode:
1282         title: Errorcode
1283         description: Error Code
1284         type: string
1285         minLength: 1
1286         x-nullable: true
1287       responseId:
1288         title: Responseid
1289         description: Response Id
1290         type: string
1291         minLength: 1
1292   JobResponseDescriptor:
1293     title: Responsedescriptor
1294     description: Job Response Descriptor
1295     type: object
1296     properties:
1297       status:
1298         title: Status
1299         description: Status
1300         type: string
1301         minLength: 1
1302       progress:
1303         title: Progress
1304         description: Job Progress
1305         type: string
1306         minLength: 1
1307       statusDescription:
1308         title: Statusdescription
1309         description: Status Description
1310         type: string
1311         minLength: 1
1312       errorCode:
1313         title: Errorcode
1314         description: Error Code
1315         type: string
1316         minLength: 1
1317         x-nullable: true
1318       responseId:
1319         title: Responseid
1320         description: Response Id
1321         type: string
1322         minLength: 1
1323       responseHistoryList:
1324         description: Response History List
1325         type: array
1326         items:
1327           $ref: '#/definitions/JobResponseHistoryList'
1328   GetJobResponse:
1329     type: object
1330     properties:
1331       jobId:
1332         title: Jobid
1333         description: Job Id
1334         type: string
1335         minLength: 1
1336       responseDescriptor:
1337         $ref: '#/definitions/JobResponseDescriptor'
1338   PostJobResponseResult:
1339     required:
1340       - result
1341     type: object
1342     properties:
1343       result:
1344         title: Result
1345         description: Result
1346         type: string
1347         minLength: 1
1348       msg:
1349         title: Msg
1350         description: Message
1351         type: string
1352         minLength: 1
1353   PostJobRequest:
1354     type: object
1355     properties:
1356       progress:
1357         title: Progress
1358         description: Job Progress
1359         type: string
1360         minLength: 1
1361       desc:
1362         title: Desc
1363         description: Description
1364         type: string
1365         minLength: 1
1366       errcode:
1367         title: Errcode
1368         description: Error Code
1369         type: string
1370         minLength: 1
1371   NsPackageInfo:
1372     title: Packageinfo
1373     description: NS Package Info
1374     type: object
1375     properties:
1376       nsdId:
1377         title: Nsdid
1378         description: NSD ID
1379         type: string
1380         minLength: 1
1381         x-nullable: true
1382       nsPackageId:
1383         title: Nspackageid
1384         description: NS Package ID
1385         type: string
1386         x-nullable: true
1387       nsdProvider:
1388         title: Nsdprovider
1389         description: NSD Provider
1390         type: string
1391         x-nullable: true
1392       nsdVersion:
1393         title: Nsdversion
1394         description: NSD Version
1395         type: string
1396         x-nullable: true
1397       csarName:
1398         title: Csarname
1399         description: CSAR name
1400         type: string
1401         x-nullable: true
1402       nsdModel:
1403         title: Nsdmodel
1404         description: NSD Model
1405         type: string
1406         x-nullable: true
1407       downloadUrl:
1408         title: Downloadurl
1409         description: URL to download NSD Model
1410         type: string
1411         minLength: 1
1412         x-nullable: true
1413     x-nullable: true
1414   NsPackage:
1415     type: object
1416     properties:
1417       csarId:
1418         title: Csarid
1419         description: CSAR ID
1420         type: string
1421         minLength: 1
1422         x-nullable: true
1423       packageInfo:
1424         $ref: '#/definitions/NsPackageInfo'
1425   InternalErrorRequest:
1426     required:
1427       - error
1428     type: object
1429     properties:
1430       error:
1431         title: Error
1432         description: Error
1433         type: string
1434         minLength: 1
1435       errorMessage:
1436         title: Errormessage
1437         description: Error Message
1438         type: string
1439         minLength: 1
1440   NsPackageDistributeRequest:
1441     required:
1442       - csarId
1443     type: object
1444     properties:
1445       csarId:
1446         title: Csarid
1447         description: csarId
1448         type: string
1449         minLength: 1
1450   NsPackageDistributeResponse:
1451     required:
1452       - status
1453       - statusDescription
1454       - errorCode
1455     type: object
1456     properties:
1457       status:
1458         title: Status
1459         description: status
1460         type: string
1461         minLength: 1
1462       statusDescription:
1463         title: Statusdescription
1464         description: statusDescription
1465         type: string
1466         minLength: 1
1467       errorCode:
1468         title: Errorcode
1469         description: errorCode
1470         type: string
1471         minLength: 1
1472   ServicePackageInfo:
1473     title: Packageinfo
1474     description: Service Package Info
1475     type: object
1476     properties:
1477       servicedId:
1478         title: Servicedid
1479         description: ServiceD ID
1480         type: string
1481         minLength: 1
1482         x-nullable: true
1483       servicePackageId:
1484         title: Servicepackageid
1485         description: Service Package ID
1486         type: string
1487         x-nullable: true
1488       servicedProvider:
1489         title: Servicedprovider
1490         description: ServiceD Provider
1491         type: string
1492         x-nullable: true
1493       servicedVersion:
1494         title: Servicedversion
1495         description: ServiceD Version
1496         type: string
1497         x-nullable: true
1498       csarName:
1499         title: Csarname
1500         description: CSAR name
1501         type: string
1502         x-nullable: true
1503       servicedModel:
1504         title: Servicedmodel
1505         description: ServiceD Model
1506         type: string
1507         x-nullable: true
1508       downloadUrl:
1509         title: Downloadurl
1510         description: URL to download ServiceD Model
1511         type: string
1512         minLength: 1
1513         x-nullable: true
1514     x-nullable: true
1515   ServicePackage:
1516     type: object
1517     properties:
1518       csarId:
1519         title: Csarid
1520         description: CSAR ID
1521         type: string
1522         minLength: 1
1523         x-nullable: true
1524       packageInfo:
1525         $ref: '#/definitions/ServicePackageInfo'
1526   ServicePackageDistributeRequest:
1527     required:
1528       - csarId
1529     type: object
1530     properties:
1531       csarId:
1532         title: Csarid
1533         description: csarId
1534         type: string
1535         minLength: 1
1536   NfPackageInfo:
1537     title: Packageinfo
1538     description: VNF Package Info
1539     required:
1540       - vnfPackageId
1541     type: object
1542     properties:
1543       vnfdId:
1544         title: Vnfdid
1545         description: VNFD ID
1546         type: string
1547         x-nullable: true
1548       vnfPackageId:
1549         title: Vnfpackageid
1550         description: VNF Package ID
1551         type: string
1552         minLength: 1
1553       vnfdProvider:
1554         title: Vnfdprovider
1555         description: VNFD Provider
1556         type: string
1557         x-nullable: true
1558       vnfdVersion:
1559         title: Vnfdversion
1560         description: VNFD Version
1561         type: string
1562         x-nullable: true
1563       vnfVersion:
1564         title: Vnfversion
1565         description: VNF Version
1566         type: string
1567         x-nullable: true
1568       csarName:
1569         title: Csarname
1570         description: CSAR Name
1571         type: string
1572         x-nullable: true
1573       vnfdModel:
1574         title: Vnfdmodel
1575         description: VNFD Model
1576         type: string
1577         x-nullable: true
1578       downloadUrl:
1579         title: Downloadurl
1580         description: URL to download VNFD Model
1581         type: string
1582         x-nullable: true
1583   NfImageInfo:
1584     description: Image Info
1585     required:
1586       - index
1587       - fileName
1588       - imageId
1589       - vimId
1590       - vimUser
1591       - tenant
1592       - status
1593     type: object
1594     properties:
1595       index:
1596         title: Index
1597         description: Index of VNF Image
1598         type: string
1599         minLength: 1
1600       fileName:
1601         title: Filename
1602         description: Image file name
1603         type: string
1604         minLength: 1
1605       imageId:
1606         title: Imageid
1607         description: Image ID
1608         type: string
1609         minLength: 1
1610       vimId:
1611         title: Vimid
1612         description: VIM ID
1613         type: string
1614         minLength: 1
1615       vimUser:
1616         title: Vimuser
1617         description: User of VIM
1618         type: string
1619         minLength: 1
1620       tenant:
1621         title: Tenant
1622         description: Tenant
1623         type: string
1624         minLength: 1
1625       status:
1626         title: Status
1627         description: Status
1628         type: string
1629         minLength: 1
1630   NfPackage:
1631     required:
1632       - csarId
1633       - packageInfo
1634     type: object
1635     properties:
1636       csarId:
1637         title: Csarid
1638         description: CSAR ID
1639         type: string
1640         minLength: 1
1641       packageInfo:
1642         $ref: '#/definitions/NfPackageInfo'
1643       imageInfo:
1644         description: Image Info
1645         type: array
1646         items:
1647           $ref: '#/definitions/NfImageInfo'
1648         x-nullable: true
1649   NfPackageDistributeRequest:
1650     required:
1651       - csarId
1652     type: object
1653     properties:
1654       csarId:
1655         title: Csarid
1656         description: CSAR ID
1657         type: string
1658         minLength: 1
1659       vimIds:
1660         description: A string for vimIds
1661         type: array
1662         items:
1663           type: string
1664           minLength: 1
1665       labVimId:
1666         title: Labvimid
1667         description: A list of VIM IDs.
1668         type: string
1669   PostJobResponse:
1670     required:
1671       - jobId
1672     type: object
1673     properties:
1674       jobId:
1675         title: Jobid
1676         description: jobId
1677         type: string
1678         minLength: 1
1679   ProblemDetails:
1680     title: Onboardingfailuredetails
1681     description: Failure details of current onboarding procedure.It shall be present
1682       when the nsdOnboardingState attribute is CREATED and the uploading or processing
1683       fails in NFVO.
1684     required:
1685       - title
1686       - detail
1687     type: object
1688     properties:
1689       type:
1690         title: Type
1691         description: A URI reference according to IETF RFC 3986 [10] that identifies
1692           the problem type.         It is encouraged that the URI provides human-readable
1693           documentation for the problem (e.g. using HTML) when dereferenced.         When
1694           this member is not present, its value is assumed to be "about:blank".
1695         type: string
1696         x-nullable: true
1697       title:
1698         title: Title
1699         description: The HTTP status code for this occurrence of the problem.
1700         type: integer
1701       detail:
1702         title: Detail
1703         description: A human-readable explanation specific to this occurrence of the
1704           problem.
1705         type: string
1706         minLength: 1
1707       instance:
1708         title: Instance
1709         description: A URI reference that identifies the specific occurrence of the
1710           problem.         It may yield further information if dereferenced.
1711         type: string
1712         x-nullable: true
1713       additional_attributes:
1714         title: Additional attributes
1715         description: Any number of additional attributes, as defined in a specification
1716           or by an implementation.
1717         type: object
1718         additionalProperties:
1719           description: Additional attribute
1720           type: string
1721         x-nullable: true
1722   UriLink:
1723     title: Self
1724     description: URI of this resource.
1725     required:
1726       - href
1727     type: object
1728     properties:
1729       href:
1730         title: Href
1731         description: URI of the referenced resource
1732         type: string
1733         minLength: 1
1734   NSD_LinkSerializer:
1735     title: ' links'
1736     description: Links to resources related to this resource.
1737     required:
1738       - self
1739       - nsd_content
1740     type: object
1741     properties:
1742       self:
1743         $ref: '#/definitions/UriLink'
1744       nsd_content:
1745         $ref: '#/definitions/UriLink'
1746   NsdInfo:
1747     required:
1748       - id
1749       - nsdOnboardingState
1750       - nsdOperationalState
1751       - nsdUsageState
1752       - _links
1753     type: object
1754     properties:
1755       id:
1756         title: Id
1757         description: Identifier of the onboarded individual NS descriptor resource.This
1758           identifier is allocated by the NFVO.
1759         type: string
1760         minLength: 1
1761       nsdId:
1762         title: Nsdid
1763         description: This identifier, which is allocated by the NSD designer,identifies
1764           the NSD in a globally unique way.It is copied from the NSD content and shall
1765           be present after the NSD content is on-boarded.
1766         type: string
1767         x-nullable: true
1768       nsdName:
1769         title: Nsdname
1770         description: Name of the onboarded NSD.This information is copied from the
1771           NSD content and shall be present after the NSD content is on-boarded.
1772         type: string
1773         x-nullable: true
1774       nsdVersion:
1775         title: Nsdversion
1776         description: Version of the on-boarded NSD.This information is copied from
1777           the NSD content and shall be present after the NSD content is on-boarded.
1778         type: string
1779         x-nullable: true
1780       nsdDesigner:
1781         title: Nsddesigner
1782         description: Designer of the on-boarded NSD.This information is copied from
1783           the NSD content and shall be present after the NSD content is on-boarded.
1784         type: string
1785         x-nullable: true
1786       nsdInvariantId:
1787         title: Nsdinvariantid
1788         description: This identifier, which is allocated by the NSD designer,identifies
1789           an NSD in a version independent manner.This information is copied from the
1790           NSD content and shall be present after the NSD content is on-boarded.
1791         type: string
1792         x-nullable: true
1793       vnfPkgIds:
1794         description: Identifies the VNF package for the VNFD referenced by the on-boarded
1795           NS descriptor resource.
1796         type: array
1797         items:
1798           description: Identifier of the VNF package
1799           type: string
1800         x-nullable: true
1801       pnfdInfoIds:
1802         description: Identifies the PnfdInfo element for the PNFD referenced by the
1803           on-boarded NS descriptor resource.
1804         type: array
1805         items:
1806           description: Identifier of the PnfdInfo element
1807           type: string
1808         x-nullable: true
1809       nestedNsdInfoIds:
1810         description: Identifies the NsdInfo element for the nested NSD referenced
1811           by the on-boarded NS descriptor resource.
1812         type: array
1813         items:
1814           description: Identifier of the NsdInfo element
1815           type: string
1816         x-nullable: true
1817       nsdOnboardingState:
1818         title: Nsdonboardingstate
1819         description: Onboarding state of the individual NS descriptor resource.
1820         type: string
1821         enum:
1822           - CREATED
1823           - UPLOADING
1824           - PROCESSING
1825           - ONBOARDED
1826       onboardingFailureDetails:
1827         $ref: '#/definitions/ProblemDetails'
1828       nsdOperationalState:
1829         title: Nsdoperationalstate
1830         description: Operational state of the individual NS descriptor resource.This
1831           attribute can be modified with the PATCH method.
1832         type: string
1833         enum:
1834           - ENABLED
1835           - DISABLED
1836       nsdUsageState:
1837         title: Nsdusagestate
1838         description: Usage state of the individual NS descriptor resource.
1839         type: string
1840         enum:
1841           - IN_USE
1842           - NOT_IN_USE
1843       userDefinedData:
1844         title: Userdefineddata
1845         description: User defined data for the individual NS descriptor resource.This
1846           attribute can be modified with the PATCH method.
1847         type: object
1848         additionalProperties:
1849           description: Key Value Pairs
1850           type: string
1851         x-nullable: true
1852       _links:
1853         $ref: '#/definitions/NSD_LinkSerializer'
1854   CreateNsdInfoRequest:
1855     type: object
1856     properties:
1857       userDefinedData:
1858         title: Userdefineddata
1859         description: User-defined data for the NS descriptor resource to be created.It
1860           shall be present when the user defined data is set for the individual NS
1861           descriptor resource to be created.
1862         type: object
1863         additionalProperties:
1864           description: Key Value Pairs
1865           type: string
1866         x-nullable: true
1867   PNFD_LinkSerializer:
1868     title: ' links'
1869     description: Links to resources related to this resource.
1870     required:
1871       - self
1872       - pnfd_content
1873     type: object
1874     properties:
1875       self:
1876         $ref: '#/definitions/UriLink'
1877       pnfd_content:
1878         $ref: '#/definitions/UriLink'
1879   PnfdInfo:
1880     required:
1881       - id
1882       - pnfdOnboardingState
1883       - pnfdUsageState
1884       - _links
1885     type: object
1886     properties:
1887       id:
1888         title: Id
1889         description: Identifier of the onboarded individual PNF descriptor resource.         This
1890           identifier is allocated by the NFVO.
1891         type: string
1892         minLength: 1
1893       pnfdId:
1894         title: Pnfdid
1895         description: This identifier, which is allocated by the PNFD designer,         identifies
1896           the PNFD in a globally unique way.         It is copied from the PNFD content
1897           and shall be present after the PNFD content is on-boarded.
1898         type: string
1899         x-nullable: true
1900       pnfdName:
1901         title: Pnfdname
1902         description: Name of the onboarded PNFD.         This information is copied
1903           from the PNFD content and shall be present after the PNFD content is on-boarded.
1904         type: string
1905         x-nullable: true
1906       pnfdVersion:
1907         title: Pnfdversion
1908         description: Version of the on-boarded PNFD.         This information is copied
1909           from the PNFD content and shall be present after the PNFD content is on-boarded.
1910         type: string
1911         x-nullable: true
1912       pnfdProvider:
1913         title: Pnfdprovider
1914         description: Provider of the on-boarded PNFD.         This information is
1915           copied from the PNFD content and shall be present after the PNFD content
1916           is on-boarded.
1917         type: string
1918         x-nullable: true
1919       pnfdInvariantId:
1920         title: Pnfdinvariantid
1921         description: Identifies a PNFD in a version independent manner.         This
1922           attribute is invariant across versions of PNFD.
1923         type: string
1924         x-nullable: true
1925       pnfdOnboardingState:
1926         title: Pnfdonboardingstate
1927         description: Onboarding state of the individual PNF descriptor resource.
1928         type: string
1929         enum:
1930           - CREATED
1931           - UPLOADING
1932           - PROCESSING
1933           - ONBOARDED
1934       onboardingFailureDetails:
1935         $ref: '#/definitions/ProblemDetails'
1936       pnfdUsageState:
1937         title: Pnfdusagestate
1938         description: Usage state of the individual PNF descriptor resource.
1939         type: string
1940         enum:
1941           - IN_USE
1942           - NOT_IN_USE
1943       userDefinedData:
1944         title: Userdefineddata
1945         description: User defined data for the individual PNF descriptor resource.         This
1946           attribute can be modified with the PATCH method.
1947         type: object
1948         additionalProperties:
1949           description: Key Value Pairs
1950           type: string
1951         x-nullable: true
1952       _links:
1953         $ref: '#/definitions/PNFD_LinkSerializer'
1954   SUBSCRIPTION_ProblemDetailsSerializer:
1955     required:
1956       - status
1957       - detail
1958     type: object
1959     properties:
1960       type:
1961         title: Type
1962         description: Type
1963         type: string
1964         minLength: 1
1965         x-nullable: true
1966       title:
1967         title: Title
1968         description: Title
1969         type: string
1970         minLength: 1
1971         x-nullable: true
1972       status:
1973         title: Status
1974         description: Status
1975         type: integer
1976       detail:
1977         title: Detail
1978         description: Detail
1979         type: string
1980         minLength: 1
1981       instance:
1982         title: Instance
1983         description: Instance
1984         type: string
1985         minLength: 1
1986         x-nullable: true
1987       additional_details:
1988         description: Any number of additional attributes, as defined in a specification
1989           or by an implementation.
1990         type: array
1991         items:
1992           type: string
1993         x-nullable: true
1994   CreatePnfdInfoRequest:
1995     type: object
1996     properties:
1997       userDefinedData:
1998         title: Userdefineddata
1999         description: User-defined data for the PNF descriptor resource to be created.It
2000           shall be present when the user defined data is set for the individual PNF
2001           descriptor resource to be created.
2002         type: object
2003         additionalProperties:
2004           description: Key Value Pairs
2005           type: string
2006         x-nullable: true
2007   NsdmNotificationsFilter:
2008     title: Filter
2009     description: Filter settings for this subscription, to define the of all notifications
2010       this subscription relates to.
2011     type: object
2012     properties:
2013       notificationTypes:
2014         description: Match particular notification types
2015         type: array
2016         items:
2017           type: string
2018           enum:
2019             - NsdOnBoardingNotification
2020             - NsdOnboardingFailureNotification
2021             - NsdChangeNotification
2022             - NsdDeletionNotification
2023             - PnfdOnBoardingNotification
2024             - PnfdOnBoardingFailureNotification
2025             - PnfdDeletionNotification
2026       nsdInfoId:
2027         description: Match NS packages with particular nsdInfoIds
2028         type: array
2029         items:
2030           type: string
2031           format: uuid
2032       nsdId:
2033         description: Match NS Packages with particular nsdIds
2034         type: array
2035         items:
2036           type: string
2037           format: uuid
2038       nsdName:
2039         description: Match NS Packages with particular nsdNames
2040         type: array
2041         items:
2042           type: string
2043           maxLength: 255
2044           minLength: 1
2045       nsdVersion:
2046         description: match NS packages that belong to certain nsdversion
2047         type: array
2048         items:
2049           type: string
2050           maxLength: 255
2051           minLength: 1
2052       nsdInvariantId:
2053         description: Match NS Packages with particular nsdInvariantIds
2054         type: array
2055         items:
2056           type: string
2057           format: uuid
2058       vnfPkgIds:
2059         description: Match NS Packages that has VNF PackageIds
2060         type: array
2061         items:
2062           type: string
2063           format: uuid
2064       nestedNsdInfoIds:
2065         description: Match NS Packages with particular nsdInvariantIds
2066         type: array
2067         items:
2068           type: string
2069           format: uuid
2070       nsdOnboardingState:
2071         description: Match NS Packages with particular NS Onboarding State
2072         type: array
2073         items:
2074           type: string
2075           enum:
2076             - CREATED
2077             - UPLOADING
2078             - PROCESSING
2079             - ONBOARDED
2080       nsdOperationalState:
2081         description: Match NS Packages with particular NS Operational State
2082         type: array
2083         items:
2084           type: string
2085           enum:
2086             - ENABLED
2087             - DISABLED
2088       nsdUsageState:
2089         description: Match NS Packages with particular NS Usage State
2090         type: array
2091         items:
2092           type: string
2093           enum:
2094             - IN_USE
2095             - NOT_IN_USE
2096       pnfdInfoIds:
2097         description: Match PF packages with particular pnfdInfoIds
2098         type: array
2099         items:
2100           type: string
2101           format: uuid
2102       pnfdId:
2103         description: Match PF packages with particular pnfdInfoIds
2104         type: array
2105         items:
2106           type: string
2107           format: uuid
2108       pnfdName:
2109         description: Match PF Packages with particular pnfdNames
2110         type: array
2111         items:
2112           type: string
2113           maxLength: 255
2114           minLength: 1
2115       pnfdVersion:
2116         description: match PF packages that belong to certain pnfd version
2117         type: array
2118         items:
2119           type: string
2120           maxLength: 255
2121           minLength: 1
2122       pnfdProvider:
2123         description: Match PF Packages with particular pnfdProvider
2124         type: array
2125         items:
2126           type: string
2127           maxLength: 255
2128           minLength: 1
2129       pnfdInvariantId:
2130         description: Match PF Packages with particular pnfdInvariantIds
2131         type: array
2132         items:
2133           type: string
2134           format: uuid
2135       pnfdOnboardingState:
2136         description: 'Match PF Packages with particular PNF Onboarding State '
2137         type: array
2138         items:
2139           type: string
2140           enum:
2141             - CREATED
2142             - UPLOADING
2143             - PROCESSING
2144             - ONBOARDED
2145       pnfdUsageState:
2146         description: Match PF Packages with particular PNF usage State
2147         type: array
2148         items:
2149           type: string
2150           enum:
2151             - IN_USE
2152             - NOT_IN_USE
2153   NSDM_SUB_LinkSerializer:
2154     title: ' links'
2155     description: Links to resources related to this resource.
2156     required:
2157       - self
2158     type: object
2159     properties:
2160       self:
2161         $ref: '#/definitions/UriLink'
2162   NsdmSubscription:
2163     required:
2164       - id
2165       - callbackUri
2166       - _links
2167     type: object
2168     properties:
2169       id:
2170         title: Id
2171         description: Identifier of this subscription resource.
2172         type: string
2173         maxLength: 255
2174         minLength: 1
2175       callbackUri:
2176         title: Callbackuri
2177         description: The URI of the endpoint to send the notification to.
2178         type: string
2179         maxLength: 255
2180         minLength: 1
2181       filter:
2182         $ref: '#/definitions/NsdmNotificationsFilter'
2183       _links:
2184         $ref: '#/definitions/NSDM_SUB_LinkSerializer'
2185   BasicAuth:
2186     title: Paramsbasic
2187     description: Parameters for authentication/authorization using BASIC.
2188     type: object
2189     properties:
2190       userName:
2191         title: Username
2192         description: Username to be used in HTTP Basic authentication.
2193         type: string
2194         maxLength: 255
2195         minLength: 1
2196       password:
2197         title: Password
2198         description: Password to be used in HTTP Basic authentication.
2199         type: string
2200         maxLength: 255
2201         minLength: 1
2202   OAuthCredentials:
2203     title: Paramsoauth2clientcredentials
2204     description: Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.
2205     type: object
2206     properties:
2207       clientId:
2208         title: Clientid
2209         description: Client identifier to be used in the access token request of the
2210           OAuth 2.0 client credentials grant type.
2211         type: string
2212         maxLength: 255
2213         minLength: 1
2214       clientPassword:
2215         title: Clientpassword
2216         description: Client password to be used in the access token request of the
2217           OAuth 2.0 client credentials grant type.
2218         type: string
2219         maxLength: 255
2220         minLength: 1
2221       tokenEndpoint:
2222         title: Tokenendpoint
2223         description: The token endpoint from which the access token can be obtained.
2224         type: string
2225         maxLength: 255
2226         minLength: 1
2227   SubscriptionAuthentication:
2228     title: Authentication
2229     description: Authentication parameters to configure the use of Authorization when
2230       sending notifications corresponding to this subscription.
2231     required:
2232       - authType
2233     type: object
2234     properties:
2235       authType:
2236         description: Defines the types of Authentication / Authorization which the
2237           API consumer is willing to accept when receiving a notification.
2238         type: array
2239         items:
2240           type: string
2241           enum:
2242             - BASIC
2243             - OAUTH2_CLIENT_CREDENTIALS
2244             - TLS_CERT
2245       paramsBasic:
2246         $ref: '#/definitions/BasicAuth'
2247       paramsOauth2ClientCredentials:
2248         $ref: '#/definitions/OAuthCredentials'
2249   NsdmSubscriptionRequest:
2250     required:
2251       - callbackUri
2252     type: object
2253     properties:
2254       callbackUri:
2255         title: Callbackuri
2256         description: The URI of the endpoint to send the notification to.
2257         type: string
2258         minLength: 1
2259       filter:
2260         $ref: '#/definitions/NsdmNotificationsFilter'
2261       authentication:
2262         $ref: '#/definitions/SubscriptionAuthentication'
2263   ParseModelRequest:
2264     required:
2265       - csarId
2266     type: object
2267     properties:
2268       csarId:
2269         title: Csarid
2270         description: CSAR ID
2271         type: string
2272         minLength: 1
2273       packageType:
2274         title: Packagetype
2275         description: 'Package type: VNF, PNF, NS, Service'
2276         type: string
2277         minLength: 1
2278       inputs:
2279         title: Inputs
2280         description: Inputs
2281         type: string
2282   ParseModelResponse:
2283     required:
2284       - model
2285     type: object
2286     properties:
2287       model:
2288         title: Model
2289         description: Model
2290         type: string
2291   VNF_SUBSCRIPTION_LINKSERIALIZER:
2292     title: Self
2293     description: URI of this resource.
2294     required:
2295       - href
2296     type: object
2297     properties:
2298       href:
2299         title: Href
2300         description: URI of the referenced resource.
2301         type: string
2302         minLength: 1
2303   LinkSelf:
2304     title: ' links'
2305     description: Links to resources related to this resource.
2306     required:
2307       - self
2308     type: object
2309     properties:
2310       self:
2311         $ref: '#/definitions/VNF_SUBSCRIPTION_LINKSERIALIZER'
2312   Version:
2313     title: Versions
2314     description: match VNF packages that contain VNF products with certain versions
2315     required:
2316       - vnfSoftwareVersion
2317     type: object
2318     properties:
2319       vnfSoftwareVersion:
2320         title: Vnfsoftwareversion
2321         description: VNF software version to match.
2322         type: string
2323         maxLength: 255
2324         minLength: 1
2325       vnfdVersions:
2326         description: Match VNF packages that contain VNF products with certain VNFD
2327           versions
2328         type: array
2329         items:
2330           type: string
2331           minLength: 1
2332   vnfProducts:
2333     title: Vnfproducts
2334     description: match VNF packages that contain VNF products with certain product
2335       names, from one particular provider
2336     required:
2337       - vnfProductName
2338     type: object
2339     properties:
2340       vnfProductName:
2341         title: Vnfproductname
2342         description: Name of the VNF product to match.
2343         type: string
2344         maxLength: 255
2345         minLength: 1
2346       versions:
2347         $ref: '#/definitions/Version'
2348   vnfProductsProviders:
2349     required:
2350       - vnfProvider
2351     type: object
2352     properties:
2353       vnfProvider:
2354         title: Vnfprovider
2355         description: Name of the VNFprovider to match.
2356         type: string
2357         maxLength: 255
2358         minLength: 1
2359       vnfProducts:
2360         $ref: '#/definitions/vnfProducts'
2361   PkgmNotificationsFilter:
2362     title: Filter
2363     description: Filter settings for this subscription, to define the subset of all
2364       notifications this subscription relates to
2365     type: object
2366     properties:
2367       notificationTypes:
2368         description: Match particular notification types
2369         type: array
2370         items:
2371           type: string
2372           enum:
2373             - VnfPackageOnboardingNotification
2374             - VnfPackageChangeNotification
2375       vnfProductsFromProviders:
2376         description: Match VNF packages that contain VNF products from certain providers.
2377         type: array
2378         items:
2379           $ref: '#/definitions/vnfProductsProviders'
2380       vnfdId:
2381         description: Match VNF packages with a VNFD identifierlisted in the attribute
2382         type: array
2383         items:
2384           type: string
2385           format: uuid
2386       vnfPkgId:
2387         description: Match VNF packages with a VNFD identifierlisted in the attribute
2388         type: array
2389         items:
2390           type: string
2391           format: uuid
2392       operationalState:
2393         description: Operational state of the VNF package.
2394         type: array
2395         items:
2396           type: string
2397           enum:
2398             - ENABLED
2399             - DISABLED
2400       usageState:
2401         description: Operational state of the VNF package.
2402         type: array
2403         items:
2404           type: string
2405           enum:
2406             - IN_USE
2407             - NOT_IN_USE
2408   PkgmSubscription:
2409     required:
2410       - id
2411       - callbackUri
2412       - _links
2413     type: object
2414     properties:
2415       id:
2416         title: Id
2417         description: Identifier of this subscription resource.
2418         type: string
2419         format: uuid
2420       callbackUri:
2421         title: Callbackuri
2422         description: The URI of the endpoint to send the notification to.
2423         type: string
2424         format: uri
2425         minLength: 1
2426       _links:
2427         $ref: '#/definitions/LinkSelf'
2428       filter:
2429         $ref: '#/definitions/PkgmNotificationsFilter'
2430   PkgmSubscriptionRequest:
2431     required:
2432       - callbackUri
2433     type: object
2434     properties:
2435       filters:
2436         $ref: '#/definitions/PkgmNotificationsFilter'
2437       callbackUri:
2438         title: Callbackuri
2439         description: Callback URI to sendthe notification
2440         type: string
2441         format: uri
2442         minLength: 1
2443       authentication:
2444         $ref: '#/definitions/SubscriptionAuthentication'
2445   Checksum:
2446     title: Checksum
2447     description: Checksum of the on-boarded VNF package.
2448     required:
2449       - algorithm
2450       - hash
2451     type: object
2452     properties:
2453       algorithm:
2454         title: Algorithm
2455         description: Name of the algorithm used to generate the checksum.
2456         type: string
2457         minLength: 1
2458       hash:
2459         title: Hash
2460         description: The hexadecimal value of the checksum.
2461         type: string
2462         minLength: 1
2463   VnfPackageSoftwareImageInfo:
2464     description: Information about VNF package artifacts that are software images.
2465     required:
2466       - id
2467       - name
2468       - provider
2469       - version
2470       - checksum
2471       - containerFormat
2472       - diskFormat
2473       - createdAt
2474       - minDisk
2475       - minRam
2476       - size
2477       - imagePath
2478     type: object
2479     properties:
2480       id:
2481         title: Id
2482         description: Identifier of the software image.
2483         type: string
2484         minLength: 1
2485       name:
2486         title: Name
2487         description: Name of the software image.
2488         type: string
2489         minLength: 1
2490       provider:
2491         title: Provider
2492         description: Provider of the software image.
2493         type: string
2494         minLength: 1
2495       version:
2496         title: Version
2497         description: Version of the software image.
2498         type: string
2499         minLength: 1
2500       checksum:
2501         $ref: '#/definitions/Checksum'
2502       containerFormat:
2503         title: Containerformat
2504         description: 'terminationType: Indicates whether forceful or graceful termination
2505           is requested.'
2506         type: string
2507         enum:
2508           - AKI
2509           - AMI
2510           - ARI
2511           - BARE
2512           - DOCKER
2513           - OVA
2514           - OVF
2515       diskFormat:
2516         title: Diskformat
2517         description: Disk format of a software image is the format of the underlying
2518           disk image.
2519         type: string
2520         enum:
2521           - AKI
2522           - AMI
2523           - ARI
2524           - ISO
2525           - QCOW2
2526           - RAW
2527           - VDI
2528           - VHD
2529           - VHDX
2530           - VMDK
2531       createdAt:
2532         title: Createdat
2533         description: Time when this software image was created.
2534         type: string
2535         format: date-time
2536       minDisk:
2537         title: Mindisk
2538         description: The minimal disk for this software image in bytes.
2539         type: integer
2540       minRam:
2541         title: Minram
2542         description: The minimal RAM for this software image in bytes.
2543         type: integer
2544       size:
2545         title: Size
2546         description: Size of this software image in bytes.
2547         type: integer
2548       userMetadata:
2549         title: Usermetadata
2550         description: User-defined data.
2551         type: object
2552         additionalProperties:
2553           description: KeyValue Pairs
2554           type: string
2555         x-nullable: true
2556       imagePath:
2557         title: Imagepath
2558         description: Path in the VNF package.
2559         type: string
2560         minLength: 1
2561   VnfPackageArtifactInfo:
2562     description: Information about VNF package artifacts contained in the VNF package
2563       that are not software images.
2564     required:
2565       - artifactPath
2566       - checksum
2567     type: object
2568     properties:
2569       artifactPath:
2570         title: Artifactpath
2571         description: Path in the VNF package.
2572         type: string
2573         minLength: 1
2574       checksum:
2575         $ref: '#/definitions/Checksum'
2576       metadata:
2577         title: Metadata
2578         description: The metadata of the artifact that are available in the VNF package
2579         type: object
2580         additionalProperties:
2581           description: KeyValue Pairs
2582           type: string
2583         x-nullable: true
2584   VNF_PKGM_Link_Serializer:
2585     title: ' links'
2586     description: Links to resources related to this resource.
2587     required:
2588       - self
2589       - packageContent
2590     type: object
2591     properties:
2592       self:
2593         $ref: '#/definitions/UriLink'
2594       vnfd:
2595         $ref: '#/definitions/UriLink'
2596       packageContent:
2597         $ref: '#/definitions/UriLink'
2598   VnfPkgInfo:
2599     required:
2600       - id
2601       - onboardingState
2602       - operationalState
2603       - usageState
2604       - _links
2605     type: object
2606     properties:
2607       id:
2608         title: Id
2609         description: Identifier of the on-boarded VNF package.
2610         type: string
2611         minLength: 1
2612       vnfdId:
2613         title: Vnfdid
2614         description: This identifier, which is managed by the VNF provider, identifies
2615           the VNF package and the VNFD in a globally unique way.
2616         type: string
2617         x-nullable: true
2618       vnfProvider:
2619         title: Vnfprovider
2620         description: Provider of the VNF package and the VNFD.
2621         type: string
2622         x-nullable: true
2623       vnfProductName:
2624         title: Vnfproductname
2625         description: Name to identify the VNF product.
2626         type: string
2627         x-nullable: true
2628       vnfSoftwareVersion:
2629         title: Vnfsoftwareversion
2630         description: Software version of the VNF.
2631         type: string
2632         x-nullable: true
2633       vnfdVersion:
2634         title: Vnfdversion
2635         description: The version of the VNvFD.
2636         type: string
2637         x-nullable: true
2638       checksum:
2639         $ref: '#/definitions/Checksum'
2640       softwareImages:
2641         description: Information about VNF package artifacts that are software images.
2642         type: array
2643         items:
2644           $ref: '#/definitions/VnfPackageSoftwareImageInfo'
2645         x-nullable: true
2646       additionalArtifacts:
2647         description: Information about VNF package artifacts contained in the VNF
2648           package that are not software images.
2649         type: array
2650         items:
2651           $ref: '#/definitions/VnfPackageArtifactInfo'
2652         x-nullable: true
2653       onboardingState:
2654         title: Onboardingstate
2655         description: On-boarding state of the VNF package.
2656         type: string
2657         enum:
2658           - CREATED
2659           - UPLOADING
2660           - PROCESSING
2661           - ONBOARDED
2662       operationalState:
2663         title: Operationalstate
2664         description: Operational state of the VNF package.
2665         type: string
2666         enum:
2667           - ENABLED
2668           - DISABLED
2669       usageState:
2670         title: Usagestate
2671         description: Usage state of the VNF package.
2672         type: string
2673         enum:
2674           - IN_USE
2675           - NOT_IN_USE
2676       userDefinedData:
2677         title: Userdefineddata
2678         description: User defined data for the VNF package.
2679         type: object
2680         additionalProperties:
2681           description: KeyValue Pairs
2682           type: string
2683         x-nullable: true
2684       _links:
2685         $ref: '#/definitions/VNF_PKGM_Link_Serializer'
2686   CreateVnfPkgInfoRequest:
2687     type: object
2688     properties:
2689       userDefinedData:
2690         title: Userdefineddata
2691         description: User defined data for the VNF package.
2692         type: object
2693         additionalProperties:
2694           description: KeyValue Pairs
2695           type: string
2696         x-nullable: true
2697   UploadVnfPackageFromUriRequest:
2698     required:
2699       - addressInformation
2700     type: object
2701     properties:
2702       addressInformation:
2703         title: Addressinformation
2704         description: Address information of the VNF package content.
2705         type: string
2706         minLength: 1
2707       userName:
2708         title: Username
2709         description: User name to be used for authentication.
2710         type: string
2711         minLength: 1
2712       password:
2713         title: Password
2714         description: Password to be used for authentication.
2715         type: string
2716         minLength: 1