genericparser/swagger/modeling.genericparser.swagger.json

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