Code Review / vfc / gvnfm / vnflcm.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Format vfc-vnflcm swagger schemas
[vfc/gvnfm/vnflcm.git] / lcm / lcm / nf / vnfs / serializers.py
diff --git a/lcm/lcm/nf/vnfs/serializers.py b/lcm/lcm/nf/vnfs/serializers.py
index ae2866a..c598496 100644 (file)
--- a/lcm/lcm/nf/vnfs/serializers.py
+++ b/lcm/lcm/nf/vnfs/serializers.py
@@ -16,119 +16,426 @@ from rest_framework import serializers
 
 
 class CreateVnfReqSerializer(serializers.Serializer):
-    vnfdId = serializers.CharField(help_text="vnfd Id", required=True)
-    vnfInstanceName = serializers.CharField(help_text="vnf Instance Name", required=True)
-    vnfInstanceDescription = serializers.CharField(help_text="vnf Instance Description", required=False, allow_null=True)
+    vnfdId = serializers.CharField(
+        help_text="vnfdId",
+        max_length=255,
+        required=True,
+        allow_null=True)
+    vnfInstanceName = serializers.CharField(
+        help_text="vnfInstanceName",
+        max_length=255,
+        required=True,
+        allow_null=False)
+    vnfInstanceDescription = serializers.CharField(
+        help_text="vnfInstanceDescription",
+        max_length=255,
+        required=False,
+        allow_null=True)
 
 
 class CreateVnfRespSerializer(serializers.Serializer):
-    vnfInstanceId = serializers.CharField(help_text="vnf Instance Id", required=True)
-
-
-class StorageResourceSerializer(serializers.Serializer):
-    resourceId = serializers.CharField(help_text="resourceId", required=True)
-    vimId = serializers.CharField(help_text="vimId", required=True)
-
-
-class virtualStorageResourceInfoSerializer(serializers.Serializer):
-    virtualStorageInstanceId = serializers.CharField(help_text="virtualStorageInstanceId", required=True)
-    storageResource = StorageResourceSerializer(help_text="storageResource", required=True)
-
-
-class virtualLinkResourceInfoSerializer(serializers.Serializer):
-    pass
-
-
-class vnfcResourceInfoSerializer(serializers.Serializer):
-    pass
-
-
-class accessInfoSerializer(serializers.Serializer):
-    tenant = serializers.CharField(help_text="tenant", required=True)
-    username = serializers.CharField(help_text="username", required=True)
-    password = serializers.CharField(help_text="password", required=True)
+    vnfInstanceId = serializers.CharField(
+        help_text="vnfInstanceId",
+        required=True,
+        max_length=255,
+        allow_null=True)
+
+
+class ResourceSerializer(serializers.Serializer):
+    resourceId = serializers.CharField(
+        help_text="resourceId",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    vimId = serializers.CharField(
+        help_text="vimId",
+        required=True,
+        max_length=255,
+        allow_null=True)
+
+
+class VirtualStorageResourceInfoSerializer(serializers.Serializer):
+    virtualStorageInstanceId = serializers.CharField(
+        help_text="virtualStorageInstanceId",
+        required=False,
+        allow_null=True,
+        max_length=255)
+    virtualStorageDescId = serializers.CharField(
+        help_text="virtualStorageDescId",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    storageResource = ResourceSerializer(
+        help_text="storageResource",
+        required=False,
+        allow_null=True)
+
+
+class VirtualLinkResourceInfoSerializer(serializers.Serializer):
+    virtualLinkInstanceId = serializers.CharField(
+        help_text="virtualLinkInstanceId",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    virtualLinkDescId = serializers.CharField(
+        help_text="virtualLinkDescId",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    networkResource = ResourceSerializer(
+        help_text="networkResource",
+        required=False,
+        allow_null=True)
+
+
+class VnfcResourceInfoSerializer(serializers.Serializer):
+    vnfcInstanceId = serializers.CharField(
+        help_text="vnfcInstanceId",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    vduId = serializers.CharField(
+        help_text="vduId",
+        required=False, max_length=255, allow_null=True)
+    storageResourceIds = serializers.CharField(
+        help_text="storageResourceIds",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    computeResource = ResourceSerializer(
+        help_text="computeResource",
+        required=False,
+        allow_null=True)
+
+
+class AccessInfoSerializer(serializers.Serializer):
+    tenant = serializers.CharField(
+        help_text="tenant",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    username = serializers.CharField(
+        help_text="username",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    password = serializers.CharField(
+        help_text="password",
+        required=True,
+        max_length=255,
+        allow_null=True)
 
 
 class InterfaceInfoSerializer(serializers.Serializer):
-    vimType = serializers.CharField(help_text="vimType", required=True)
-    apiVersion = serializers.CharField(help_text="apiVersion", required=True)
-    protocolType = serializers.ChoiceField(help_text="protocolType", choices=['http', 'https'], required=True)
-
-
-class vimInfoSerializer(serializers.Serializer):
-    vimInfoId = serializers.CharField(help_text="vimInfoId", required=True)
-    vimId = serializers.CharField(help_text="vimId", required=True)
-    interfaceEndpoint = serializers.CharField(help_text="interfaceEndpoint", required=True)
-    interfaceInfo = InterfaceInfoSerializer(help_text="vimInfoId", required=True)
-    accessInfo = accessInfoSerializer(help_text="accessInfo", required=True)
-
-
-class monitoringParametersSerializer(serializers.Serializer):
-    pass
-
-
-class linkPortsSerializer(serializers.Serializer):
-    resourceId = serializers.CharField(help_text="resourceId", required=True)
-    vimId = serializers.CharField(help_text="vimId", required=False)
-
-
-class resourceHandleSerializer(serializers.Serializer):
-    resourceId = serializers.CharField(help_text="resourceId", required=True)
-    vimId = serializers.CharField(help_text="vimId", required=False)
-    resourceProviderId = serializers.CharField(help_text="resourceProviderId", required=False)
+    vimType = serializers.CharField(
+        help_text="vimType",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    apiVersion = serializers.CharField(
+        help_text="apiVersion",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    protocolType = serializers.ChoiceField(
+        help_text="protocolType",
+        choices=['http', 'https'],
+        required=True)
+
+
+class VimInfoSerializer(serializers.Serializer):
+    vimInfoId = serializers.CharField(
+        help_text="vimInfoId",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    vimId = serializers.CharField(
+        help_text="vimId",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    interfaceEndpoint = serializers.CharField(
+        help_text="interfaceEndpoint",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    interfaceInfo = InterfaceInfoSerializer(
+        help_text="vimInfoId",
+        required=False,
+        allow_null=True)
+    accessInfo = AccessInfoSerializer(
+        help_text="accessInfo",
+        required=False,
+        allow_null=True)
+
+
+class LinkPortsSerializer(serializers.Serializer):
+    resourceId = serializers.CharField(
+        help_text="resourceId",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    vimId = serializers.CharField(
+        help_text="vimId",
+        required=False,
+        max_length=255,
+        allow_null=True)
+
+
+class ResourceHandleSerializer(serializers.Serializer):
+    resourceId = serializers.CharField(
+        help_text="resourceId",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    vimId = serializers.CharField(
+        help_text="vimId",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    resourceProviderId = serializers.CharField(
+        help_text="resourceProviderId",
+        required=False,
+        max_length=255,
+        allow_null=True)
 
 
 class ExtVirtualLinkInfoSerializer(serializers.Serializer):
-    extVirtualLinkId = serializers.CharField(help_text="extVirtualLinkId", required=True)
-    resourceHandle = resourceHandleSerializer(help_text="iPAddress", required=True)
-    linkPorts = linkPortsSerializer(help_text="iPAddress", many=True, allow_null=True)
-
-
-class l3AddressDataSerializer(serializers.Serializer):
-    iPAddressType = serializers.ChoiceField(help_text="iPAddressType", choices=['IPv4', 'IPv6'], required=True)
-    iPAddress = serializers.CharField(help_text="iPAddress", required=True)
+    extVirtualLinkId = serializers.CharField(
+        help_text="extVirtualLinkId",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    resourceHandle = ResourceHandleSerializer(
+        help_text="iPAddress",
+        required=True)
+    linkPorts = LinkPortsSerializer(
+        help_text="iPAddress",
+        many=True,
+        allow_null=True)
+
+
+class L3AddressDataSerializer(serializers.Serializer):
+    iPAddressType = serializers.ChoiceField(
+        help_text="iPAddressType",
+        choices=['IPv4', 'IPv6'],
+        required=True)
+    iPAddress = serializers.CharField(
+        help_text="iPAddress",
+        required=True,
+        max_length=255,
+        allow_null=True)
 
 
 class NetworkAddressSerializer(serializers.Serializer):
-    addressType = serializers.ChoiceField(help_text="addressType", choices=['MAC', 'IP'], required=True)
-    l2AddressData = serializers.CharField(help_text="l2AddressData", required=False)
-    l3AddressData = l3AddressDataSerializer(help_text="addresses", required=False)
-
-
-class extCpInfoSerializer(serializers.Serializer):
-    cpInstanceId = serializers.CharField(help_text="cpInstanceId", required=True)
-    cpdId = serializers.IntegerField(help_text="cpdId", required=True)
-    addresses = NetworkAddressSerializer(help_text="addresses", many=True, allow_null=True)
+    addressType = serializers.ChoiceField(
+        help_text="addressType",
+        choices=['MAC', 'IP'],
+        required=True)
+    l2AddressData = serializers.CharField(
+        help_text="l2AddressData",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    l3AddressData = L3AddressDataSerializer(
+        help_text="addresses",
+        required=False)
+
+
+class ExtCpInfoSerializer(serializers.Serializer):
+    cpInstanceId = serializers.CharField(
+        help_text="cpInstanceId",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    cpdId = serializers.CharField(
+        help_text="cpdId",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    numDynamicAddresses = serializers.CharField(
+        help_text="numDynamicAddresses",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    addresses = NetworkAddressSerializer(
+        help_text="addresses",
+        many=True,
+        allow_null=True)
 
 
 class ScaleInfoSerializer(serializers.Serializer):
-    aspectId = serializers.CharField(help_text="aspectId", required=True)
-    scaleLevel = serializers.IntegerField(help_text="scaleLevel", required=True)
+    aspectId = serializers.CharField(
+        help_text="aspectId",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    scaleLevel = serializers.IntegerField(
+        help_text="scaleLevel",
+        required=True)
 
 
 class instantiatedVnfInfoSerializer(serializers.Serializer):
-    flavourId = serializers.CharField(help_text="flavour Id", required=True, allow_null=True)
-    vnfState = serializers.ChoiceField(help_text="vnf State", choices=['STARTED', 'STOPPED'], required=True, allow_null=True)
-    scaleStatus = ScaleInfoSerializer(help_text="scaleStatus", many=True)
-    extCpInfo = extCpInfoSerializer(help_text="extCpInfo", many=True)
-    extVirtualLink = ExtVirtualLinkInfoSerializer(help_text="extVirtualLink", many=True)
-    monitoringParameters = monitoringParametersSerializer(help_text="monitoringParameters", allow_null=True)
-    vimInfo = vimInfoSerializer(help_text="vimInfo", many=True)
-    vnfcResourceInfo = vnfcResourceInfoSerializer(help_text="vnfcResourceInfo", many=True)
-    virtualLinkResourceInfo = virtualLinkResourceInfoSerializer(help_text="virtualLinkResourceInfo", many=True)
-    virtualStorageResourceInfo = virtualStorageResourceInfoSerializer(help_text="virtualStorageResourceInfo", many=True)
-    pass
+    flavourId = serializers.CharField(
+        help_text="flavourId",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    vnfState = serializers.ChoiceField(
+        help_text="vnfState",
+        choices=['STARTED', 'STOPPED'],
+        required=True,
+        allow_null=True)
+    scaleStatus = ScaleInfoSerializer(
+        help_text="scaleStatus",
+        many=True)
+    extCpInfo = ExtCpInfoSerializer(
+        help_text="extCpInfo",
+        many=True)
+    extVirtualLink = ExtVirtualLinkInfoSerializer(
+        help_text="extVirtualLink",
+        many=True)
+    monitoringParameters = serializers.DictField(
+        help_text="monitoringParameters",
+        child=serializers.CharField(allow_blank=True),
+        required=False,
+        allow_null=True)
+    vimInfo = VimInfoSerializer(
+        help_text="vimInfo",
+        many=True)
+    vnfcResourceInfo = VnfcResourceInfoSerializer(
+        help_text="vnfcResourceInfo",
+        many=True)
+    virtualLinkResourceInfo = VirtualLinkResourceInfoSerializer(
+        help_text="virtualLinkResourceInfo",
+        many=True)
+    virtualStorageResourceInfo = VirtualStorageResourceInfoSerializer(
+        help_text="virtualStorageResourceInfo",
+        many=True)
 
 
 class VnfInfoSerializer(serializers.Serializer):
-    vnfInstanceId = serializers.CharField(help_text="vnf Instance Id", required=True)
-    vnfInstanceName = serializers.CharField(help_text="vnf Instance Name", required=True)
-    onboardedVnfPkgInfoId = serializers.CharField(help_text="onboarded Vnf Pkg Info Id", required=False,
-                                                  allow_null=True)
-    vnfdVersion = serializers.CharField(help_text="vnfd Version", required=False, allow_null=True)
-    vnfProvider = serializers.CharField(help_text="vnf Provider", required=False, allow_null=True)
-    instantiatedVnfInfo = instantiatedVnfInfoSerializer(help_text="instantiatedVnfInfo", required=True)
+    vnfInstanceId = serializers.CharField(
+        help_text="vnfInstanceId",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    vnfInstanceName = serializers.CharField(
+        help_text="vnfInstanceName",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    onboardedVnfPkgInfoId = serializers.CharField(
+        help_text="onboardedVnfPkgInfoId",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    vnfdVersion = serializers.CharField(
+        help_text="vnfdVersion",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    vnfProvider = serializers.CharField(
+        help_text="vnfProvider",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    instantiatedVnfInfo = instantiatedVnfInfoSerializer(
+        help_text="instantiatedVnfInfo",
+        required=True)
 
 
 class VnfsInfoSerializer(serializers.ListSerializer):
     child = VnfInfoSerializer()
+
+
+class ExtVirtualLinkSerizlizer(serializers.Serializer):
+    vlInstanceId = serializers.CharField(
+        help_text="vlInstanceId",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    resourceSubnetId = serializers.CharField(
+        help_text="resourceSubnetId",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    cpdId = serializers.CharField(
+        help_text="cpdId",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    resourceId = serializers.CharField(
+        help_text="resourceId",
+        required=False,
+        max_length=255,
+        allow_null=True)
+    vim = VimInfoSerializer(
+        help_text="vim",
+        required=False,
+        allow_null=True)
+    extCps = ExtCpInfoSerializer(
+        help_text="extCps",
+        many=True,
+        required=False,
+        allow_null=True)
+
+
+class AdditionalParamsSerializer(serializers.Serializer):
+    inputs = serializers.DictField(
+        help_text="inputs",
+        child=serializers.CharField(help_text="custom key-value", allow_blank=True),
+        required=False,
+        allow_null=True)
+    extVirtualLinks = serializers.ListSerializer(
+        help_text="extVirtualLinks",
+        child=ExtVirtualLinkSerizlizer(help_text="extVirtualLinks", required=False, allow_null=True),
+        required=False,
+        allow_null=True)
+
+
+class InstantiateVnfRequestSerializer(serializers.Serializer):
+    flavourId = serializers.CharField(
+        help_text="flavourId",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    instantiationLevelId = serializers.CharField(
+        help_text="instantiationLevelId",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    localizationLanguage = serializers.CharField(
+        help_text="localizationLanguage",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    extVirtualLinks = serializers.ListSerializer(
+        help_text="extVirtualLinks",
+        child=ExtVirtualLinkSerizlizer(help_text="extVirtualLinks", required=False, allow_null=True),
+        required=False,
+        allow_null=True)
+    additionalParams = AdditionalParamsSerializer(
+        help_text="additionalParams",
+        required=False,
+        allow_null=True)
+
+
+class InstOrTeriVnfResponseSerializer(serializers.Serializer):
+    jobId = serializers.CharField(
+        help_text="jobId",
+        required=True,
+        max_length=255,
+        allow_null=True)
+
+
+class TerminateVnfRequestSerializer(serializers.Serializer):
+    terminationType = serializers.CharField(
+        help_text="terminationType",
+        required=True,
+        max_length=255,
+        allow_null=True)
+    gracefulTerminationTimeout = serializers.IntegerField(
+        help_text="gracefulTerminationTimeout",
+        default=120,
+        required=False)
Generic VNFM VNF LCM