Udpate description of vnfres serializers 11/61211/1
authorfujinhua <fu.jinhua@zte.com.cn>
Mon, 20 Aug 2018 06:16:03 +0000 (14:16 +0800)
committerfujinhua <fu.jinhua@zte.com.cn>
Mon, 20 Aug 2018 06:16:03 +0000 (14:16 +0800)
Change-Id: Id5e4c9d87d0b8ff1ae106fc6979105f1dce17bf3
Issue-ID: VFC-1009
Signed-off-by: fujinhua <fu.jinhua@zte.com.cn>
res/res/resources/serializers.py

index 92f83e9..90c7fde 100644 (file)
@@ -17,12 +17,12 @@ from rest_framework import serializers
 
 class ResourceSerializer(serializers.Serializer):
     resourceId = serializers.CharField(
-        help_text="resourceId",
+        help_text="ID of resource",
         required=True,
         max_length=255,
         allow_null=True)
     vimId = serializers.CharField(
-        help_text="vimId",
+        help_text="ID of VIM",
         required=True,
         max_length=255,
         allow_null=True)
@@ -30,73 +30,73 @@ class ResourceSerializer(serializers.Serializer):
 
 class VirtualStorageResourceInfoSerializer(serializers.Serializer):
     virtualStorageInstanceId = serializers.CharField(
-        help_text="virtualStorageInstanceId",
+        help_text="ID of virtual storage instance",
         required=False,
         max_length=255,
         allow_null=True)
     virtualStorageDescId = serializers.CharField(
-        help_text="virtualStorageDescId",
+        help_text="Description ID of virtual storage",
         required=False,
         max_length=255,
         allow_null=True)
     storageResource = ResourceSerializer(
-        help_text="storageResource",
+        help_text="Storage resource",
         required=False,
         allow_null=True)
 
 
 class VirtualLinkResourceInfoSerializer(serializers.Serializer):
     virtualLinkInstanceId = serializers.CharField(
-        help_text="virtualLinkInstanceId",
+        help_text="ID of virtual link instance",
         required=False,
         max_length=255,
         allow_null=True)
     virtualLinkDescId = serializers.CharField(
-        help_text="virtualLinkDescId",
+        help_text="Description ID of virtual link",
         required=False,
         max_length=255,
         allow_null=True)
     networkResource = ResourceSerializer(
-        help_text="networkResource",
+        help_text="Network resource",
         required=False,
         allow_null=True)
 
 
 class VnfcResourceInfoSerializer(serializers.Serializer):
     vnfcInstanceId = serializers.CharField(
-        help_text="vnfcInstanceId",
+        help_text="ID of vnfc instance",
         required=False,
         max_length=255,
         allow_null=True)
     vduId = serializers.CharField(
-        help_text="vduId",
+        help_text="Id of virtual data unit",
         required=False,
         max_length=255,
         allow_null=True)
     storageResourceIds = serializers.CharField(
-        help_text="storageResourceIds",
+        help_text="ID list of storage resources",
         required=False,
         max_length=255,
         allow_null=True)
     computeResource = ResourceSerializer(
-        help_text="computeResource",
+        help_text="Compute resource",
         required=False,
         allow_null=True)
 
 
 class AccessInfoSerializer(serializers.Serializer):
     tenant = serializers.CharField(
-        help_text="tenant",
+        help_text="Tenant",
         required=False,
         max_length=255,
         allow_null=True)
     username = serializers.CharField(
-        help_text="username",
+        help_text="User Name",
         required=False,
         max_length=255,
         allow_null=True)
     password = serializers.CharField(
-        help_text="password",
+        help_text="Password",
         required=False,
         max_length=255,
         allow_null=True)
@@ -104,17 +104,17 @@ class AccessInfoSerializer(serializers.Serializer):
 
 class InterfaceInfoSerializer(serializers.Serializer):
     vimType = serializers.CharField(
-        help_text="vimType",
+        help_text="VIM type",
         required=False,
         max_length=255,
         allow_null=True)
     apiVersion = serializers.CharField(
-        help_text="apiVersion",
+        help_text="API version",
         required=False,
         max_length=255,
         allow_null=True)
     protocolType = serializers.ChoiceField(
-        help_text="protocolType",
+        help_text="Protocol type",
         choices=['http', 'https'],
         required=False,
         allow_null=True)
@@ -122,90 +122,90 @@ class InterfaceInfoSerializer(serializers.Serializer):
 
 class VmResponseSerializer(serializers.Serializer):
     vmid = serializers.CharField(
-        help_text="vmid",
+        help_text="ID of VM",
         required=True,
         max_length=255,
         allow_null=True)
     vimid = serializers.CharField(
-        help_text="vimid",
+        help_text="ID of VIM",
         required=True,
         max_length=255,
         allow_null=True)
     resouceid = serializers.CharField(
-        help_text="resouceid",
+        help_text="ID of resource",
         required=True,
         max_length=255,
         allow_null=True)
     tenant = serializers.CharField(
-        help_text="tenant",
+        help_text="Tenant",
         required=True,
         max_length=255,
         allow_null=True)
     instid = serializers.CharField(
-        help_text="instid",
+        help_text="ID of instance",
         required=True,
         max_length=255,
         allow_null=True)
     vmname = serializers.CharField(
-        help_text="vmname",
+        help_text="Name of VM",
         required=True,
         max_length=255,
         allow_null=True)
     insttype = serializers.IntegerField(
-        help_text="insttype",
+        help_text="Instance type",
         required=True,
         allow_null=True)
     operationalstate = serializers.CharField(
-        help_text="operationalstate",
+        help_text="Operational state",
         required=True,
         max_length=255,
         allow_null=True)
     is_predefined = serializers.IntegerField(
-        help_text="is_predefined",
+        help_text="Is predefined",
         required=True,
         allow_null=True)
     security_groups = serializers.CharField(
-        help_text="security_groups",
+        help_text="Security groups",
         required=True,
         max_length=255,
         allow_null=True)
     flavor_id = serializers.CharField(
-        help_text="flavor_id",
+        help_text="ID of flavor",
         required=True,
         max_length=255,
         allow_null=True)
     availability_zone = serializers.CharField(
-        help_text="availability_zone",
+        help_text="Availability zone",
         required=True,
         max_length=255,
         allow_null=True)
     server_group = serializers.CharField(
-        help_text="server_group",
+        help_text="Server group",
         required=True,
         max_length=255,
         allow_null=True)
     volume_array = serializers.CharField(
-        help_text="volume_array",
+        help_text="Volume array",
         required=True,
         max_length=255,
         allow_null=True)
     metadata = serializers.CharField(
-        help_text="metadata",
+        help_text="Metadata",
         required=True,
         max_length=255,
         allow_null=True)
     nic_array = serializers.CharField(
-        help_text="nic_array",
+        help_text="Nic array",
         required=True,
         max_length=255,
         allow_null=True)
     create_time = serializers.CharField(
-        help_text="create_time",
+        help_text="Create time",
         required=False,
         max_length=255,
         allow_null=True)
     nodeId = serializers.CharField(
-        help_text="nodeId",
+        help_text="ID of node",
         required=False,
         max_length=255,
         allow_null=True)