nokiav2/generatedapis/src/main/resources/vfc.catalog.swagger.json

   1 {\r
   2   "swagger": "2.0",\r
   3   "info": {\r
   4     "version": "1.0.0",\r
   5     "title": "ONAP VFC Catalog Rest API",\r
   6     "description": "VFC Catalog Management API.",\r
   7     "contact": {\r
   8       "name": "ONAP VFC team",\r
   9       "email": "onap-discuss@lists.onap.org",\r
  10       "url": "https://gerrit.onap.org/r/#/admin/projects/vfc/nfvo/catalog"\r
  11     }\r
  12   },\r
  13   "basePath": "/api/catalog/v1",\r
  14   "schemes": [\r
  15     "http",\r
  16     "https"\r
  17   ],\r
  18   "consumes": [\r
  19     "application/json"\r
  20   ],\r
  21   "produces": [\r
  22     "application/json"\r
  23   ],\r
  24   "paths": {\r
  25     "/nspackages": {\r
  26       "get": {\r
  27         "tags": [\r
  28           "nspackage"\r
  29         ],\r
  30         "summary": "query ns packages info",\r
  31         "description": "query ns packages info",\r
  32         "operationId": "query_ns_packages",\r
  33         "parameters": [],\r
  34         "responses": {\r
  35           "200": {\r
  36             "description": "successful operation",\r
  37             "schema": {\r
  38               "$ref": "#/definitions/NsPkgListInfo"\r
  39             }\r
  40           },\r
  41           "404": {\r
  42             "description": "URL not found"\r
  43           },\r
  44           "500": {\r
  45             "description": "internal error"\r
  46           }\r
  47         }\r
  48       },\r
  49       "post": {\r
  50         "tags": [\r
  51           "nspackage"\r
  52         ],\r
  53         "summary": "ns package distribute",\r
  54         "description": "ns package distribute",\r
  55         "operationId": "ns_pkg_distribute",\r
  56         "parameters": [\r
  57           {\r
  58             "in": "body",\r
  59             "name": "body",\r
  60             "description": "distribute request param",\r
  61             "required": true,\r
  62             "schema": {\r
  63               "$ref": "#/definitions/NsPkgDistributeRequest"\r
  64             }\r
  65           }\r
  66         ],\r
  67         "responses": {\r
  68           "202": {\r
  69             "description": "",\r
  70             "schema": {\r
  71               "$ref": "#/definitions/NsPkgDistributeResponse"\r
  72             }\r
  73           },\r
  74           "404": {\r
  75             "description": "URL not found"\r
  76           },\r
  77           "500": {\r
  78             "description": "internal error"\r
  79           }\r
  80         }\r
  81       }\r
  82     },\r
  83     "/nspackages/{csarId}": {\r
  84       "get": {\r
  85         "tags": [\r
  86           "nspackage"\r
  87         ],\r
  88         "summary": "query ns package info",\r
  89         "description": "query ns package info via ns package csarId",\r
  90         "operationId": "query_ns_package",\r
  91         "consumes": [\r
  92           "application/json"\r
  93         ],\r
  94         "produces": [\r
  95           "application/json"\r
  96         ],\r
  97         "parameters": [\r
  98           {\r
  99             "name": "csarId",\r
 100             "in": "path",\r
 101             "description": "csar id of ns package",\r
 102             "required": true,\r
 103             "type": "string"\r
 104           }\r
 105         ],\r
 106         "responses": {\r
 107           "200": {\r
 108             "description": "successful operation",\r
 109             "schema": {\r
 110               "$ref": "#/definitions/NsPkgDetailInfo"\r
 111             }\r
 112           },\r
 113           "404": {\r
 114             "description": "URL not found"\r
 115           },\r
 116           "500": {\r
 117             "description": "internal error"\r
 118           }\r
 119         }\r
 120       },\r
 121       "delete": {\r
 122         "tags": [\r
 123           "nspackage"\r
 124         ],\r
 125         "summary": "delete ns pkg",\r
 126         "description": "delete ns pkg",\r
 127         "operationId": "delete_ns_pkg",\r
 128         "consumes": [\r
 129           "application/json"\r
 130         ],\r
 131         "produces": [\r
 132           "application/json"\r
 133         ],\r
 134         "parameters": [\r
 135           {\r
 136             "name": "csarId",\r
 137             "in": "path",\r
 138             "description": "csar id of ns package",\r
 139             "required": true,\r
 140             "type": "string"\r
 141           }\r
 142         ],\r
 143         "responses": {\r
 144           "202": {\r
 145             "description": "",\r
 146             "schema": {\r
 147               "$ref": "#/definitions/NsPkgDelResponse"\r
 148             }\r
 149           },\r
 150           "404": {\r
 151             "description": "URL not found"\r
 152           },\r
 153           "500": {\r
 154             "description": "internal error"\r
 155           }\r
 156         }\r
 157       }\r
 158     },\r
 159     "/parsernsd": {\r
 160       "post": {\r
 161         "tags": [\r
 162           "model"\r
 163         ],\r
 164         "summary": "ns package model",\r
 165         "description": "ns package model",\r
 166         "operationId": "ms_model_parser",\r
 167         "consumes": [\r
 168           "application/json"\r
 169         ],\r
 170         "produces": [\r
 171           "application/json"\r
 172         ],\r
 173         "parameters": [\r
 174           {\r
 175             "in": "body",\r
 176             "name": "body",\r
 177             "description": "distribute request param",\r
 178             "required": true,\r
 179             "schema": {\r
 180               "$ref": "#/definitions/modelParserRequest"\r
 181             }\r
 182           }\r
 183         ],\r
 184         "responses": {\r
 185           "202": {\r
 186             "description": "",\r
 187             "schema": {\r
 188               "$ref": "#/definitions/modelParserResponse"\r
 189             }\r
 190           },\r
 191           "404": {\r
 192             "description": "URL not found"\r
 193           },\r
 194           "500": {\r
 195             "description": "internal error"\r
 196           }\r
 197         }\r
 198       }\r
 199      },\r
 200     "/vnfpackages": {\r
 201       "get": {\r
 202         "tags": [\r
 203           "vnfpackage"\r
 204         ],\r
 205         "summary": "query vnf packages info",\r
 206         "description": "query vnf packages info",\r
 207         "operationId": "query_vnf_packages",\r
 208         "consumes": [\r
 209           "application/json"\r
 210         ],\r
 211         "produces": [\r
 212           "application/json"\r
 213         ],\r
 214         "parameters": [],\r
 215         "responses": {\r
 216           "200": {\r
 217             "description": "successful operation",\r
 218             "schema": {\r
 219               "$ref": "#/definitions/VnfPkgListInfo"\r
 220             }\r
 221           },\r
 222           "404": {\r
 223             "description": "URL not found"\r
 224           },\r
 225           "500": {\r
 226             "description": "internal error"\r
 227           }\r
 228         }\r
 229       },\r
 230       "post": {\r
 231         "tags": [\r
 232           "vnfpackage"\r
 233         ],\r
 234         "summary": "vnf package distribute",\r
 235         "description": "vnf package distribute",\r
 236         "operationId": "vnf_pkg_distribute",\r
 237         "consumes": [\r
 238           "application/json"\r
 239         ],\r
 240         "produces": [\r
 241           "application/json"\r
 242         ],\r
 243         "parameters": [\r
 244           {\r
 245             "in": "body",\r
 246             "name": "body",\r
 247             "description": "distribute request param",\r
 248             "required": true,\r
 249             "schema": {\r
 250               "$ref": "#/definitions/VnfPkgDistributeRequest"\r
 251             }\r
 252           }\r
 253         ],\r
 254         "responses": {\r
 255           "202": {\r
 256             "description": "",\r
 257             "schema": {\r
 258               "$ref": "#/definitions/VnfPkgDistributeResponse"\r
 259             }\r
 260           },\r
 261           "404": {\r
 262             "description": "URL not found"\r
 263           },\r
 264           "500": {\r
 265             "description": "internal error"\r
 266           }\r
 267         }\r
 268       }\r
 269     },\r
 270     "/vnfpackages/{csarId}": {\r
 271       "get": {\r
 272         "tags": [\r
 273           "vnfpackage"\r
 274         ],\r
 275         "summary": "query vnf package info",\r
 276         "description": "query one vnf package info via vnf package csarId",\r
 277         "operationId": "query_vnf_package",\r
 278         "consumes": [\r
 279           "application/json"\r
 280         ],\r
 281         "produces": [\r
 282           "application/json"\r
 283         ],\r
 284         "parameters": [\r
 285           {\r
 286             "name": "csarId",\r
 287             "in": "path",\r
 288             "description": "csar id of vnf package",\r
 289             "required": true,\r
 290             "type": "string"\r
 291           }\r
 292         ],\r
 293         "responses": {\r
 294           "200": {\r
 295             "description": "successful operation",\r
 296             "schema": {\r
 297               "$ref": "#/definitions/VnfPkgDetailInfo"\r
 298             }\r
 299           },\r
 300           "404": {\r
 301             "description": "URL not found"\r
 302           },\r
 303           "500": {\r
 304             "description": "internal error"\r
 305           }\r
 306         }\r
 307       },\r
 308       "delete": {\r
 309         "tags": [\r
 310           "vnfpackage"\r
 311         ],\r
 312         "summary": "delete vnf package",\r
 313         "description": "delete vnf package",\r
 314         "operationId": "delete_vnf_package",\r
 315         "consumes": [\r
 316           "application/json"\r
 317         ],\r
 318         "produces": [\r
 319           "application/json"\r
 320         ],\r
 321         "parameters": [\r
 322           {\r
 323             "name": "csarId",\r
 324             "in": "path",\r
 325             "description": "csar id of vnf package",\r
 326             "required": true,\r
 327             "type": "string"\r
 328           }\r
 329         ],\r
 330         "responses": {\r
 331           "202": {\r
 332             "description": "",\r
 333             "schema": {\r
 334               "$ref": "#/definitions/VnfPkgDelResponse"\r
 335             }\r
 336           },\r
 337           "404": {\r
 338             "description": "URL not found"\r
 339           },\r
 340           "500": {\r
 341             "description": "internal error"\r
 342           }\r
 343         }\r
 344       }\r
 345     },\r
 346     "/parservnfd": {\r
 347       "post": {\r
 348         "tags": [\r
 349           "model"\r
 350         ],\r
 351         "summary": "vnf package model",\r
 352         "description": "vnf package model",\r
 353         "operationId": "vnf_model_parser",\r
 354         "consumes": [\r
 355           "application/json"\r
 356         ],\r
 357         "produces": [\r
 358           "application/json"\r
 359         ],\r
 360         "parameters": [\r
 361           {\r
 362             "in": "body",\r
 363             "name": "body",\r
 364             "description": "distribute request param",\r
 365             "required": true,\r
 366             "schema": {\r
 367               "$ref": "#/definitions/modelParserRequest"\r
 368             }\r
 369           }\r
 370         ],\r
 371         "responses": {\r
 372           "202": {\r
 373             "description": "",\r
 374             "schema": {\r
 375               "$ref": "#/definitions/modelParserResponse"\r
 376             }\r
 377           },\r
 378           "404": {\r
 379             "description": "URL not found"\r
 380           },\r
 381           "500": {\r
 382             "description": "internal error"\r
 383           }\r
 384         }\r
 385       }\r
 386      },\r
 387      "/jobs/{jobId}": {\r
 388        "get": {\r
 389         "tags": [\r
 390           "job"\r
 391         ],\r
 392         "summary": "jobstatus",\r
 393         "description": "",\r
 394         "operationId": "get_jobstatus",\r
 395         "parameters": [\r
 396           {\r
 397             "required": true,\r
 398             "type": "string",\r
 399             "description": "job Id",\r
 400             "name": "jobId",\r
 401             "in": "path"\r
 402           },\r
 403           {\r
 404             "required": true,\r
 405             "type": "string",\r
 406             "description": "job response message id",\r
 407             "name": "responseId",\r
 408             "in": "query"\r
 409           }\r
 410         ],\r
 411         "responses": {\r
 412           "202": {\r
 413             "description": "",\r
 414              "schema": {\r
 415               "$ref": "#/definitions/JobDetailInfo"\r
 416             }\r
 417           }\r
 418         }\r
 419       }\r
 420     }\r
 421   },\r
 422   "definitions": {\r
 423     "NsPkgDistributeRequest": {\r
 424       "type": "object",\r
 425       "properties": {\r
 426         "csarId": {\r
 427           "type": "string",\r
 428           "description": "network service package id, UUID"\r
 429         }\r
 430       }\r
 431     },\r
 432     "NsPkgDistributeResponse": {\r
 433       "type": "object",\r
 434       "properties": {\r
 435         "status": {\r
 436           "type": "string",\r
 437           "description": "Operation status. value is success or failed"\r
 438         },\r
 439         "statusDescription": {\r
 440           "type": "string",\r
 441           "description": "description about the operation result"\r
 442         },\r
 443         "errorCode": {\r
 444           "type": "string",\r
 445           "description": "If the status is failed, the errorcode will be returned"\r
 446         }\r
 447       }\r
 448     },\r
 449     "NsPkgDelResponse": {\r
 450       "type": "object",\r
 451       "properties": {\r
 452         "status": {\r
 453           "type": "string",\r
 454           "description": "Operation status. value is success or failed"\r
 455         },\r
 456         "statusDescription": {\r
 457           "type": "string",\r
 458           "description": "description about the operation result"\r
 459         },\r
 460         "errorCode": {\r
 461           "type": "string",\r
 462           "description": "If the status is failed, the errorcode will be returned"\r
 463         }\r
 464       }\r
 465     },\r
 466     "NsPkgListInfo": {\r
 467       "type": "array",\r
 468       "items": {\r
 469         "$ref": "#/definitions/NsPkgInfo"\r
 470       }\r
 471     },\r
 472     "NsPkgDetailInfo": {\r
 473       "type": "object",\r
 474       "properties": {\r
 475         "csarId": {\r
 476           "type": "string"\r
 477         },\r
 478         "packageInfo": {\r
 479           "$ref": "#/definitions/NsPkgInfo"\r
 480         },\r
 481         "instanceInfo": {\r
 482           "$ref": "#/definitions/NsInstListInfo"\r
 483         }\r
 484       }\r
 485     },\r
 486     "NsPkgInfo": {\r
 487       "type": "object",\r
 488       "properties": {\r
 489         "nsPackageId": {\r
 490           "type": "string",\r
 491           "description": "The identifer of the NS (csarId)"\r
 492         },\r
 493         "nsdId": {\r
 494           "type": "string",\r
 495           "description": "network service descriptor identifer (same as csarId)"\r
 496         },\r
 497         "csarName": {\r
 498           "type": "string",\r
 499           "description": "The name of the CSAR"\r
 500         },\r
 501         "nsdProvider": {\r
 502           "type": "string",\r
 503           "description": "network service designer name"\r
 504         },\r
 505         "nsdVersion": {\r
 506           "type": "string",\r
 507           "description": "network service descriptor version"\r
 508         },\r
 509         "downloadUrl": {\r
 510           "type": "string",\r
 511           "description": "The URL from which the NSD package can be downloaded from"\r
 512         },\r
 513         "nsdModel": {\r
 514           "type": "string",\r
 515           "description": "The parsed model of the NSD (JSON encoded into string)"\r
 516         }\r
 517       }\r
 518     },\r
 519     "NsInstListInfo": {\r
 520       "type": "array",\r
 521       "items": {\r
 522         "$ref": "#/definitions/NsInstInfo"\r
 523       }\r
 524     },\r
 525     "NsInstInfo": {\r
 526       "type": "object",\r
 527       "properties": {\r
 528         "nsInstanceId": {\r
 529           "type": "string",\r
 530           "description": "network service instance ID"\r
 531         },\r
 532         "nsInstanceName": {\r
 533           "type": "string",\r
 534           "description": "network service instance name"\r
 535         }\r
 536       }\r
 537     },\r
 538     "VnfPkgDistributeRequest": {\r
 539       "type": "object",\r
 540       "properties": {\r
 541         "csarId": {\r
 542           "type": "string",\r
 543           "description": "vnf package id, UUID"\r
 544         }\r
 545       }\r
 546     },\r
 547     "VnfPkgDistributeResponse": {\r
 548       "type": "object",\r
 549       "properties": {\r
 550         "jobId": {\r
 551           "type": "string",\r
 552           "description": "VNF package distribute job ID"\r
 553         }\r
 554       }\r
 555     },\r
 556     "VnfPkgDelResponse": {\r
 557       "type": "object",\r
 558       "properties": {\r
 559         "status": {\r
 560           "type": "string",\r
 561           "description": "Operation status. value is success or failed"\r
 562         },\r
 563         "statusDescription": {\r
 564           "type": "string",\r
 565           "description": "description about the operation result"\r
 566         },\r
 567         "errorCode": {\r
 568           "type": "string",\r
 569           "description": "If the status is failed, the errorcode will be returned"\r
 570         }\r
 571       }\r
 572     },\r
 573     "VnfPkgListInfo": {\r
 574       "type": "array",\r
 575       "items": {\r
 576         "$ref": "#/definitions/VnfPkgInfo"\r
 577       }\r
 578     },\r
 579     "VnfPkgDetailInfo": {\r
 580       "type": "object",\r
 581       "properties": {\r
 582         "csarId": {\r
 583           "type": "string",\r
 584           "description": "vnf package id, UUID"\r
 585         },\r
 586         "packageInfo": {\r
 587           "$ref": "#/definitions/VnfPkgInfo"\r
 588         },\r
 589         "imageInfo": {\r
 590           "$ref": "#/definitions/VnfPkgImgListInfo"\r
 591         },\r
 592         "vnfInstanceInfo": {\r
 593           "$ref": "#/definitions/VnfInstListInfo"\r
 594         }\r
 595       }\r
 596     },\r
 597     "VnfPkgInfo": {\r
 598       "type": "object",\r
 599       "description": "vnf package infomation",\r
 600       "properties": {\r
 601         "vnfPackageId": {\r
 602           "type": "string",\r
 603           "description": "The identifier of the VNF package (csarId)"\r
 604         },\r
 605         "csarName": {\r
 606           "type": "string",\r
 607           "description": "The name of the CSAR"\r
 608         },\r
 609         "vnfdId": {\r
 610           "type": "string",\r
 611           "description": "VNF descriptor ID (same as CSAR ID)"\r
 612         },\r
 613         "vnfdProvider": {\r
 614           "type": "string",\r
 615           "description": "VNF descriptor vendor ID"\r
 616         },\r
 617         "vnfdVersion": {\r
 618           "type": "string",\r
 619           "description": "VNF descriptor version"\r
 620         },\r
 621         "vnfVersion": {\r
 622           "type": "string",\r
 623           "description": "VNF Software version"\r
 624         },\r
 625         "vnfdModel":{\r
 626           "type": "string",\r
 627           "description": "The model of the VNFD (JSON encoded into string)"\r
 628         },\r
 629         "downloadUrl":{\r
 630           "type": "string",\r
 631           "description": "The URL from which the package can be downloaded from"\r
 632         }\r
 633       }\r
 634     },\r
 635     "VnfInstListInfo": {\r
 636       "type": "array",\r
 637       "items": {\r
 638         "$ref": "#/definitions/VnfInstInfo"\r
 639       }\r
 640     },\r
 641     "VnfInstInfo": {\r
 642       "type": "object",\r
 643       "properties": {\r
 644         "vnfInstanceId": {\r
 645           "type": "string",\r
 646           "description": "VNF instance ID"\r
 647         },\r
 648         "vnfInstanceName": {\r
 649           "type": "string",\r
 650           "description": "VNF instance name"\r
 651         }\r
 652       }\r
 653     },\r
 654     "VnfPkgImgListInfo": {\r
 655       "type": "array",\r
 656       "items": {\r
 657         "$ref": "#/definitions/VnfPkgImgInfo"\r
 658       }\r
 659     },\r
 660     "VnfPkgImgInfo": {\r
 661       "type": "object",\r
 662       "properties": {\r
 663         "fileName": {\r
 664           "type": "string",\r
 665           "description": "image file name"\r
 666         },\r
 667         "imageUrl": {\r
 668           "type": "string",\r
 669           "description": "image file path in the csar or image url in external repository"\r
 670         }\r
 671       }\r
 672     },\r
 673     "modelParserRequest":{\r
 674       "type": "object",\r
 675       "properties": {\r
 676         "csarId": {\r
 677           "type": "string",\r
 678           "description": "csar Package Id"\r
 679         },\r
 680         "inputs": {\r
 681           "type": "object",\r
 682           "description": "csar package json inputs"\r
 683         }\r
 684       }\r
 685     },\r
 686     "modelParserResponse":{\r
 687       "type": "object",\r
 688       "properties": {\r
 689         "model": {\r
 690           "type": "object",\r
 691           "description": "csar model json data"\r
 692         }\r
 693       }\r
 694     },\r
 695     "jobResponseInfo": {\r
 696        "type": "object",\r
 697        "properties": {\r
 698           "status": {\r
 699             "type": "string"\r
 700           },\r
 701          "progress":{\r
 702             "type": "string"\r
 703          },\r
 704          "statusDescription": {\r
 705             "type": "string"\r
 706          },\r
 707          "errorCode": {\r
 708             "type": "string"\r
 709          },\r
 710          "responseId": {\r
 711             "type": "string"\r
 712         }\r
 713        }\r
 714     },\r
 715     "JobDetailInfo":{\r
 716       "type": "object",\r
 717       "properties": {\r
 718             "jobId": {\r
 719                "type": "string"\r
 720              },\r
 721             "responseDescriptor":\r
 722             {\r
 723                 "type":"object",\r
 724                 "properties": {\r
 725                     "status": {\r
 726                        "type": "string"\r
 727                     },\r
 728                     "progress":{\r
 729                        "type": "string"\r
 730                     },\r
 731                     "statusDescription": {\r
 732                        "type": "string"\r
 733                     },\r
 734                     "errorCode": {\r
 735                        "type": "string"\r
 736                     },\r
 737                     "responseId": {\r
 738                        "type": "string"\r
 739                     },\r
 740                     "responseHistoryList": {\r
 741                         "type": "array",\r
 742                         "items": {\r
 743                            "$ref": "#/definitions/jobResponseInfo"\r
 744                         }\r
 745                     }\r
 746                 }\r
 747            }\r
 748       }\r
 749     }\r
 750   }\r
 751 }\r