X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=lcm%2Fswagger%2Fvfc.vnfdriver.swagger.json;h=52f94c5eadff959add51669154e04fc05d84301c;hb=9586301e0f04ff26eaac0c589b1d405e61399fc1;hp=49f74cdf9c0ca394a798396942f76044139a1924;hpb=b0d27ae27e3cbd210fd181cbefe1fb430a6a6d22;p=vfc%2Fnfvo%2Flcm.git diff --git a/lcm/swagger/vfc.vnfdriver.swagger.json b/lcm/swagger/vfc.vnfdriver.swagger.json index 49f74cdf..52f94c5e 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", @@ -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,17 +616,26 @@ } } }, + "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" } } @@ -653,7 +683,7 @@ }, "additionalParam": { "type": "object", - "description": "The data type is KeyValuePair. Additional parameters passed by the NFVO, specific to the VNF and the LCM operation." + "description": "Additional parameters passed to the NFVO, specific to the VNF and the LCM operation. The currently interpreted keys are the following: vimId" } } }, @@ -663,49 +693,17 @@ "vim": { "type": "object", "properties": { - "vimInfoId": { + "vimid": { "type": "string" }, - "vimId": { - "type": "string" - }, - "interfaceInfo": { - "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": { + "accessinfo": { "type": "object", "properties": { "tenant": { "type": "string", - "description": "Tenant Name of tenant" - }, - "username": { - "type": "string", - "description": "Username for login" - }, - "password": { - "type": "string", - "description": "Password of login user" + "description": "The name of the tenant" } } - }, - "interfaceEndpoint": { - "type": "string", - "description": "Information about the interface endpoint. It is a URL" } } } @@ -735,15 +733,15 @@ "$ref": "#/definitions/VnfNotificationType", "description": "The type of the change" }, - "vimid": { + "vimId": { "type": "string", "description": "Identifier of vim" }, - "vmid": { + "vmId": { "type": "string", "description": "Identifier of virtual machine" }, - "vmname": { + "vmName": { "type": "string", "description": "Name of virtual machine" } @@ -764,7 +762,7 @@ "type": "string", "description": "Identifier of the VL instance" }, - "vldid": { + "vldId": { "type": "string", "description": "Identifier of the VLD in the VNFD" }, @@ -783,6 +781,10 @@ "resourceId": { "type": "string", "description": "Identifier of the resource in the scope of the VIM" + }, + "resourceName": { + "type": "string", + "description": "Name of the resource in the scope of the VIM" } } } @@ -804,11 +806,11 @@ "type": "string", "description": "Identifier of the VL instance" }, - "cpinstanceid": { + "cpInstanceId": { "type": "string", "description": "Identifier of the connection point" }, - "cpdid": { + "cpdId": { "type": "string", "description": "Identifier of the connection point in the VNFD" }, @@ -828,11 +830,11 @@ "type": "object", "description": "port Resource", "properties": { - "vimid": { + "vimId": { "type": "string", "description": "Identifier of the VIM" }, - "resourceid": { + "resourceId": { "type": "string", "description": "Identifier of the resource in the scope of the VIM" }, @@ -941,7 +943,8 @@ } }, "additionalParam": { - "type": "object" + "type": "object", + "description": "Additional parameters passed to the VNFM. The vimId may be passed in the additional parameter section by the NFVO to VNFM." } } }, @@ -962,7 +965,6 @@ } } }, - "VnfInstantiateResponse": { "type": "object", "properties": { @@ -1157,9 +1159,13 @@ "type": "object", "description": "vnf package infomation", "properties": { - "csarId": { + "vnfPackageId": { "type": "string", - "description": "vnf package id, UUID" + "description": "vnf package id (csarId)" + }, + "csarName": { + "type": "string", + "description": "The name of the csar" }, "vnfdId": { "type": "string", @@ -1169,6 +1175,10 @@ "type": "string", "description": "VNF descriptor vendor ID" }, + "vnfdModel": { + "type": "string", + "description": "The model of the VNF (JSON) encoded to string" + }, "vnfdVersion": { "type": "string", "description": "VNF descriptor version" @@ -1177,9 +1187,9 @@ "type": "string", "description": "VNF Software version" }, - "downloadUri":{ + "downloadUrl":{ "type": "string", - "description": "The download uri of VNF package" + "description": "The URL from which the VNF package can be downloaded" } } }, @@ -1319,7 +1329,7 @@ }, "sslCacert": { "type": "string", - "description": "CA file content if enabled ssl on auth-url" + "description": "The collection of trusted certificates towards the VIM connection." }, "sslInsecure": { "type": "string",