5 "title": "ONAP Modeling etsicatalog Rest API",
6 "description": "Modeling etsicatalog Management API.",
8 "name": "ONAP Modeling team",
9 "email": "onap-discuss@lists.onap.org",
10 "url": "https://gerrit.onap.org/r/#/admin/projects/modeling/etsicatalog"
13 "basePath": "/api/catalog/v1",
30 "summary": "query ns packages info",
31 "description": "query ns packages info",
32 "operationId": "query_ns_packages",
36 "description": "successful operation",
38 "$ref": "#/definitions/NsPkgListInfo"
42 "description": "URL not found"
45 "description": "internal error"
53 "summary": "ns package distribute",
54 "description": "ns package distribute",
55 "operationId": "ns_pkg_distribute",
60 "description": "distribute request param",
63 "$ref": "#/definitions/NsPkgDistributeRequest"
71 "$ref": "#/definitions/NsPkgDistributeResponse"
75 "description": "URL not found"
78 "description": "internal error"
83 "/nspackages/{csarId}": {
88 "summary": "query ns package info",
89 "description": "query ns package info via ns package csarId",
90 "operationId": "query_ns_package",
101 "description": "csar id of ns package",
108 "description": "successful operation",
110 "$ref": "#/definitions/NsPkgDetailInfo"
114 "description": "URL not found"
117 "description": "internal error"
125 "summary": "delete ns pkg",
126 "description": "delete ns pkg",
127 "operationId": "delete_ns_pkg",
138 "description": "csar id of ns package",
145 "description": "Delete NS Package Response",
147 "$ref": "#/definitions/NsPkgDelResponse"
151 "description": "URL not found"
154 "description": "internal error"
164 "summary": "ns package model",
165 "description": "ns package model",
166 "operationId": "ms_model_parser",
177 "description": "distribute request param",
180 "$ref": "#/definitions/modelParserRequest"
188 "$ref": "#/definitions/modelParserResponse"
192 "description": "URL not found"
195 "description": "internal error"
205 "summary": "query vnf packages info",
206 "description": "query vnf packages info",
207 "operationId": "query_vnf_packages",
217 "description": "successful operation",
219 "$ref": "#/definitions/VnfPkgListInfo"
223 "description": "URL not found"
226 "description": "internal error"
234 "summary": "vnf package distribute",
235 "description": "vnf package distribute",
236 "operationId": "vnf_pkg_distribute",
247 "description": "distribute request param",
250 "$ref": "#/definitions/VnfPkgDistributeRequest"
258 "$ref": "#/definitions/VnfPkgDistributeResponse"
262 "description": "URL not found"
265 "description": "internal error"
270 "/vnfpackages/{csarId}": {
275 "summary": "query vnf package info",
276 "description": "query one vnf package info via vnf package csarId",
277 "operationId": "query_vnf_package",
288 "description": "csar id of vnf package",
295 "description": "successful operation",
297 "$ref": "#/definitions/VnfPkgDetailInfo"
301 "description": "URL not found"
304 "description": "internal error"
312 "summary": "delete vnf package",
313 "description": "delete vnf package",
314 "operationId": "delete_vnf_package",
325 "description": "csar id of vnf package",
332 "description": "Delete VNF Pakcage Response",
334 "$ref": "#/definitions/VnfPkgDelResponse"
338 "description": "URL not found"
341 "description": "internal error"
351 "summary": "vnf package model",
352 "description": "vnf package model",
353 "operationId": "vnf_model_parser",
364 "description": "distribute request param",
367 "$ref": "#/definitions/modelParserRequest"
375 "$ref": "#/definitions/modelParserResponse"
379 "description": "URL not found"
382 "description": "internal error"
392 "summary": "jobstatus",
393 "description": "Get Job Status",
394 "operationId": "get_jobstatus",
399 "description": "job Id",
406 "description": "job response message id",
407 "name": "responseId",
415 "$ref": "#/definitions/JobDetailInfo"
424 "summary": "Update Job Status",
425 "description": "Update Job Status",
426 "operationId": "post_jobstatus",
431 "description": "job Id",
438 "$ref": "#/definitions/PostJobRequest"
440 "description": "job status",
441 "name": "responseId",
449 "$ref": "#/definitions/JobDetailInfo"
457 "NsPkgDistributeRequest": {
462 "description": "network service package id, UUID"
466 "NsPkgDistributeResponse": {
471 "description": "Operation status. value is success or failed"
473 "statusDescription": {
475 "description": "description about the operation result"
479 "description": "If the status is failed, the errorcode will be returned"
483 "NsPkgDelResponse": {
488 "description": "Operation status. value is success or failed"
490 "statusDescription": {
492 "description": "description about the operation result"
496 "description": "If the status is failed, the errorcode will be returned"
503 "$ref": "#/definitions/NsPkgDetailInfo"
513 "$ref": "#/definitions/NsPkgInfo"
522 "description": "network service package id, UUID, csarId"
526 "description": "network service descriptor ID"
530 "description": "network service designer name"
534 "description": "network service descriptor version"
538 "description": "network service package name"
542 "description": "ns JSON string parsed and transformed by parser"
546 "description": "download url of network service package"
553 "$ref": "#/definitions/NsInstInfo"
561 "description": "network service instance ID"
565 "description": "network service instance name"
569 "VnfPkgDistributeRequest": {
574 "description": "vnf package id, UUID"
578 "VnfPkgDistributeResponse": {
583 "description": "VNF package distribute job ID"
587 "VnfPkgDelResponse": {
592 "description": "Operation status. value is success or failed"
594 "statusDescription": {
596 "description": "description about the operation result"
600 "description": "If the status is failed, the errorcode will be returned"
607 "$ref": "#/definitions/VnfPkgDetailInfo"
610 "VnfPkgDetailInfo": {
615 "description": "vnf package id, UUID"
618 "$ref": "#/definitions/VnfPkgInfo"
621 "$ref": "#/definitions/VnfPkgImgListInfo"
627 "description": "vnf package infomation",
631 "description": "vnf package id (csarId)"
635 "description": "The name of the csar"
639 "description": "VNF descriptor ID"
643 "description": "VNF descriptor vendor ID"
647 "description": "The model of the VNF (JSON) encoded to string"
651 "description": "VNF descriptor version"
655 "description": "VNF Software version"
659 "description": "The URL from which the VNF package can be downloaded"
666 "$ref": "#/definitions/VnfInstInfo"
674 "description": "VNF instance ID"
678 "description": "VNF instance name"
682 "VnfPkgImgListInfo": {
685 "$ref": "#/definitions/VnfPkgImgInfo"
693 "description": "image file name"
697 "description": "image file path in the csar or image url in external repository"
701 "modelParserRequest":{
706 "description": "csar Package Id"
710 "description": "csar package json inputs"
714 "modelParserResponse":{
719 "description": "csar model json data"
732 "statusDescription": {
763 "responseDescriptor":
773 "statusDescription": {
782 "responseHistoryList": {
785 "$ref": "#/definitions/jobResponseInfo"