X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=lcm%2Fswagger%2Fvfc.vnfdriver.swagger.json;h=54d8f6401f240022c4beca2af11bbe9a8b8af894;hb=0c8058270469ad6184ec1ad86f7903e4b7397c7d;hp=9359cc9bb3c5baa49f2384f6cfb439491ea764e5;hpb=b7ae6077d657a971ec3bf8f86f327a66569b1a68;p=vfc%2Fnfvo%2Flcm.git diff --git a/lcm/swagger/vfc.vnfdriver.swagger.json b/lcm/swagger/vfc.vnfdriver.swagger.json index 9359cc9b..54d8f640 100644 --- a/lcm/swagger/vfc.vnfdriver.swagger.json +++ b/lcm/swagger/vfc.vnfdriver.swagger.json @@ -345,7 +345,7 @@ } } }, - "/nslcm/v1/vnfs/{vnfInstanceId}/Notify": { + "/nslcm/v1/ns/{vnfmid}/vnfs/{vnfInstanceId}/Notify": { "post": { "tags": [ "NSLCM" @@ -354,6 +354,13 @@ "description": "VNF LCM Notification API should be provided by NSLCM component", "operationId": "VNF_LCM_Notification", "parameters": [ + { + "required": true, + "type": "string", + "description": "VNFM Instance Id", + "name": "vnfmid", + "in": "path" + }, { "required": true, "type": "string", @@ -461,7 +468,7 @@ } } }, - "/nslcm/vl/vnfms/{vnfmid}":{ + "/nslcm/v1/vnfms/{vnfmid}":{ "get": { "tags": [ "NSLCM" @@ -500,7 +507,7 @@ } } }, - "/nslcm/vl/vims/{vimid}":{ + "/nslcm/v1/vims/{vimid}":{ "get": { "tags": [ "NSLCM" @@ -561,6 +568,17 @@ } } }, + "JobStatus" : { + "description": "The status of the job", + "type": "string", + "enum": [ + "started", + "processing", + "finished", + "error", + "timeout" + ] + }, "JobDetailInfo": { "type": "object", "properties": { @@ -571,13 +589,16 @@ "type": "object", "properties": { "status": { - "type": "string" + "$ref": "#/definitions/JobStatus", + "description": "The status of the job" }, "progress": { - "type": "string" + "type": "string", + "description": "The progress of the job. Value between 0 and 100." }, "statusDescription": { - "type": "string" + "type": "string", + "description": "The reason of the current status of the job." }, "errorCode": { "type": "string" @@ -595,21 +616,43 @@ } } }, + "ChangeType" : { + "description": "The type of the change", + "type": "string", + "enum": [ + "VDU" + ] + }, "ResourceChange" : { "type": "object", "properties": { "type": { - "type": "string", - "description": " The value should be VDU,VL,CP,Strorage." + "$ref": "#/definitions/ChangeType", + "description": "The type of the resource." }, "resourceDefinitionId": { + "description": "The identifier of the resource within the grant request.", "type": "string" }, "vdu": { + "description": "The identifier of the VDU.", "type": "string" } } }, + "OperationType" : { + "description": "The type of operation", + "type": "string", + "enum": [ + "Terminal", + "Instantiate", + "Scalein", + "Scaleout", + "Scaledown", + "Scaleup", + "Heal" + ] + }, "GrantVNFRequest": { "type": "object", "properties": { @@ -620,8 +663,8 @@ "type": "string" }, "lifecycleOperation": { - "type": "string", - "description": "The value should be Instantiate,Scaleout,Scalein,Scaleup,Scaledown, Heal, Terminal" + "description" : "The type of the operation.", + "$ref": "#/definitions/OperationType" }, "jobId": { "type": "string" @@ -650,49 +693,17 @@ "vim": { "type": "object", "properties": { - "vimInfoId": { - "type": "string" - }, - "vimId": { + "vimid": { "type": "string" }, - "interfaceInfo": { + "accessinfo": { "type": "object", - "properties": { - "vimType": { - "type": "string", - "description": "The vim Type value wil be openstack" - }, - "apiVersion": { - "type": "string", - "description": "The api Version Type value will be " - }, - "protocolType": { - "type": "string", - "description": "The protocol Type value will be http or https" - } - } - }, - "accessInfo": { - "type": "string", "properties": { "tenant": { "type": "string", "description": "Tenant Name of tenant" - }, - "username": { - "type": "string", - "description": "Username for login" - }, - "password": { - "type": "string", - "description": "Password of login user" } } - }, - "interfaceEndpoint": { - "type": "string", - "description": "Information about the interface endpoint. It is a URL" } } } @@ -850,19 +861,30 @@ "AffectedVirtualStorage" : { "type": "object" }, - "VNFLCMNotification": { + "VnfLcmNotificationStatus" : { + "description": "The status of the operation", + "type": "string", + "enum": [ + "result", + "start" + ] + }, + "VNFLCMNotification": { "type": "object", "properties": { "status": { - "type": "string" + "description" : "The status of the operation that triggered the LCN.", + "$ref": "#/definitions/VnfLcmNotificationStatus" }, "vnfInstanceId": { "type": "string" }, "operation": { - "type": "string" + "description" : "The type of the operation that tiggered the LCN.", + "$ref": "#/definitions/OperationType" }, "jobId": { + "description" : "The identifier fo the job that triggered the LCN.", "type": "string" }, "affectedVnfc": { @@ -950,12 +972,20 @@ } } }, + "ScaleDirection" : { + "description": "The direction of the scaling", + "type": "string", + "enum": [ + "SCALE_IN", + "SCALE_OUT" + ] + }, "VnfScaleRequest":{ "type": "object", "properties": { "type": { - "type": "string", - "description": "The VNF scale type value should be SCALE_OUT, SCALE_IN" + "description" : "The direction of the scaling.", + "$ref": "#/definitions/ScaleDirection" }, "aspectId":{ "type": "string", @@ -993,15 +1023,25 @@ } } }, + "VnfTerminationType": { + "description": "The type of the termination.", + "type": "string", + "enum": [ + "graceful", + "forceful" + ] + }, "VnfTerminateRequest":{ "type": "object", "properties": { "terminationType": { - "type": "string" + "description" : "The type of the termination", + "$ref": "#/definitions/VnfTerminationType" }, "gracefulTerminationTimeout": { + "description": "The time interval(second) to wait for the VNF to be taken out of service during graceful termination.", "type": "string" - } + } } }, "JobInfo": { @@ -1071,7 +1111,7 @@ } }, "accessInfo": { - "type": "string", + "type": "object", "properties": { "tenant": { "type": "string", @@ -1241,23 +1281,23 @@ }, "name": { "type": "string", - "description": "vnfm name" + "description": "vim name" }, "type": { "type": "string", - "description": "vnfm type" + "description": "vim type" }, "url": { "type": "string", - "description": "vnfm url" + "description": "vim url" }, "userName": { "type": "string", - "description": "vnfm login username" + "description": "vim login username" }, "password": { "type": "string", - "description": "vnfm login password" + "description": "vim login password" }, "vendor": { "type": "string", @@ -1265,15 +1305,27 @@ }, "version": { "type": "string", - "description": "vnfm version" + "description": "vim version" }, "description": { "type": "string", - "description": "vnfm description" + "description": "vim description" }, "createTime": { "type": "string", - "description": "vnfm info createTime" + "description": "vim info createTime" + }, + "sslCacert": { + "type": "string", + "description": "The collection of trusted certificates towards the VIM connection." + }, + "sslInsecure": { + "type": "string", + "description": "Whether to verify VIM's certificate" + }, + "status": { + "type": "string", + "description": "The status of external system" } } }