Add INFO.yaml file
[vfc/nfvo/lcm.git] / lcm / swagger / vfc.vnfdriver.swagger.json
index d1db684..fc35adb 100644 (file)
         },
         "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"
         }
       }
     },
         "vim": {
           "type": "object",
           "properties": {
-            "vimInfoId": {
-              "type": "string"
-            },
-            "vimId": {
+            "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"
             }
           }
         }
            "$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"
          }
            "type": "string",
            "description": "Identifier of the VL instance"
          },
-         "vldid": {
+         "vldId": {
            "type": "string",
            "description": "Identifier of the VLD in the VNFD"
          },
              "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"
              }
            }
          }
            "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"
          },
            "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"
              },
           }
         },
         "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."
         }
       }
     },
     "extVirtualLinkInfo":{
         "type": "object",
         "properties": {
+          "resourceSubnetId": {
+            "type": "string",
+            "description": "The provider id of the subnet"
+          },
           "vlInstanceId": {
-            "type": "string"
+            "type": "string",
+            "description" : "The identifier of the virtual link"
           },
-          "networkId": {
-            "type": "string"
+          "resourceId": {
+            "type": "string",
+            "description": "The provider id of the network"
           },
           "cpdId": {
-            "type": "string"
+            "type": "string",
+            "description": "The identifier of the connection point descriptor"
           },
           "vim": {
-            "$ref": "#/definitions/vimInfo"
+            "type": "object",
+            "properties": {
+               "vimid": {
+                  "type": "string",
+                  "description": "The identifier of the VIM"
+               }
+            }
           }
         }
     },
-            
     "VnfInstantiateResponse": {
       "type": "object",
       "properties": {
       "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",
           "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"
           "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"
         }
       }
     },