fix serializer typo error 35/88735/1
authormaopengzhang <zhang.maopeng1@zte.com.cn>
Wed, 29 May 2019 06:29:54 +0000 (14:29 +0800)
committermaopengzhang <zhang.maopeng1@zte.com.cn>
Wed, 29 May 2019 06:29:54 +0000 (14:29 +0800)
zte vnfm driver serializer help text error

Change-Id: Ia0582846b627611dc2d6ad4ffdb9ae08d5939abe
Issue-ID: VFC-1405
Signed-off-by: maopengzhang <zhang.maopeng1@zte.com.cn>
zte/vmanager/driver/interfaces/serializers.py

index 069797f..0c1666b 100644 (file)
@@ -17,47 +17,47 @@ from rest_framework import serializers
 
 class AdditionalParamSerializer(serializers.Serializer):
     sdncontroller = serializers.CharField(
-        help_text="sdncontroller",
+        help_text="SDN Controller identification",
         required=True,
         max_length=255,
         allow_null=True)
     NatIpRange = serializers.CharField(
-        help_text="NatIpRange",
+        help_text="Nat ip address range",
         required=True,
         max_length=255,
         allow_null=True)
     m6000_mng_ip = serializers.CharField(
-        help_text="m6000_mng_ip",
+        help_text="M6000 management ip address",
         required=True,
         max_length=255,
         allow_null=True)
     externalPluginManageNetworkName = serializers.CharField(
-        help_text="externalPluginManageNetworkName",
+        help_text="External plugin management network name",
         required=True,
         max_length=255,
         allow_null=True)
     location = serializers.CharField(
-        help_text="location",
+        help_text="SDN controller location",
         required=True,
         max_length=255,
         allow_null=True)
     externalManageNetworkName = serializers.CharField(
-        help_text="externalManageNetworkName",
+        help_text="External Management Network Name",
         required=True,
         max_length=255,
         allow_null=True)
     sfc_data_network = serializers.CharField(
-        help_text="sfc_data_network",
+        help_text="SFC data plane network",
         required=True,
         max_length=255,
         allow_null=True)
     externalDataNetworkName = serializers.CharField(
-        help_text="externalDataNetworkName",
+        help_text="External data plane network name",
         required=True,
         max_length=255,
         allow_null=True)
     inputs = serializers.DictField(
-        help_text='inputs',
+        help_text='Input parameters',
         child=serializers.CharField(allow_blank=True),
         required=False,
         allow_null=True)
@@ -65,41 +65,41 @@ class AdditionalParamSerializer(serializers.Serializer):
 
 class InstantiateVnfRequestSerializer(serializers.Serializer):
     vnfInstanceName = serializers.CharField(
-        help_text="vnfInstanceName",
+        help_text="Vnf instance name",
         required=True,
         max_length=255,
         allow_null=True)
     vnfPackageId = serializers.CharField(
-        help_text="vnfPackageId",
+        help_text="Vnf package identification",
         required=True,
         max_length=255,
         allow_null=True)
     vnfDescriptorId = serializers.CharField(
-        help_text="vnfDescriptorId",
+        help_text="Vnf descriptor identification",
         required=True,
         max_length=255,
         allow_null=True)
     additionalParam = AdditionalParamSerializer(
-        help_text="additionalParam",
+        help_text="Additional parameters",
         required=True,
         allow_null=True)
 
 
 class TerminateVnfRequestSerializer(serializers.Serializer):
     terminationType = serializers.CharField(
-        help_text="terminationType",
+        help_text="Termination type",
         required=True,
         max_length=255,
         allow_null=True)
     gracefulTerminationTimeout = serializers.IntegerField(
-        help_text="gracefulTerminationTimeout",
+        help_text="Graceful termination timeout",
         default=120,
         required=False)
 
 
 class VnfInfoSerializer(serializers.Serializer):
     vnfStatus = serializers.CharField(
-        help_text="vnfStatus",
+        help_text="Vnf status",
         required=True,
         max_length=255,
         allow_null=True)
@@ -107,87 +107,87 @@ class VnfInfoSerializer(serializers.Serializer):
 
 class QueryVnfResponseSerializer(serializers.Serializer):
     vnfInfo = VnfInfoSerializer(
-        help_text="vnfInfo",
+        help_text="Vnf instance information",
         required=True)
 
 
 class JobHistorySerializer(serializers.Serializer):
     status = serializers.CharField(
-        help_text="Status of job",
+        help_text="Status of the job",
         required=True,
         allow_null=False)
     progress = serializers.IntegerField(
-        help_text="Progress of job",
+        help_text="Progress of the job",
         required=True,
         allow_null=False)
     statusDescription = serializers.CharField(
-        help_text="Description of job",
+        help_text="Description of the job",
         required=False,
         allow_null=True)
     errorCode = serializers.CharField(
-        help_text="Error code of job",
+        help_text="Error code of the job",
         required=False,
         allow_blank=True)
     responseId = serializers.IntegerField(
-        help_text="Response index of job",
+        help_text="Response index of the job",
         required=True,
         allow_null=False)
 
 
 class JobDescriptorSerializer(serializers.Serializer):
     status = serializers.CharField(
-        help_text="Status of job",
+        help_text="Status of the job",
         required=True,
         allow_null=False)
     progress = serializers.IntegerField(
-        help_text="Progress of job",
+        help_text="Progress of the job",
         required=True,
         allow_null=False)
     statusDescription = serializers.CharField(
-        help_text="Description of job",
+        help_text="Description of the job",
         required=False,
         allow_null=True)
     errorCode = serializers.CharField(
-        help_text="Error code of job",
+        help_text="Error code of the job",
         required=False,
         allow_blank=True)
     responseId = serializers.IntegerField(
-        help_text="Response index of job",
+        help_text="Response index of the job",
         required=True,
         allow_null=False)
     responseHistoryList = JobHistorySerializer(
-        help_text="History of job",
+        help_text="History information of the job",
         many=True)
 
 
 class JobQueryRespSerializer(serializers.Serializer):
     jobId = serializers.CharField(
-        help_text="UUID of job",
+        help_text="UUID of the job",
         required=True,
         allow_null=False)
     responseDescriptor = JobDescriptorSerializer(
-        help_text="Descriptor of job",
+        help_text="Information of the job",
         required=False)
 
 
 class GrantVmlistSerializer(serializers.Serializer):
     VMNumber = serializers.CharField(
-        help_text="VMNumber",
+        help_text="The number of virtual machine",
         max_length=255,
         required=False,
         allow_null=True)
     VMFlavor = serializers.CharField(
-        help_text="VMFlavor",
+        help_text="The flavor of virtual machines",
         max_length=255,
         required=False,
         allow_null=True)
     vimid = serializers.CharField(
-        help_text="vimid",
+        help_text="The VIM identification that virtual machines belong to",
         max_length=255,
         required=True,
         allow_blank=True)
     tenant = serializers.CharField(
-        help_text="tenant",
+        help_text="The tenant that virtual machines belong to",
         max_length=255,
         required=False,
         allow_blank=True)
@@ -195,48 +195,48 @@ class GrantVmlistSerializer(serializers.Serializer):
 
 class GrantReqSerializer(serializers.Serializer):
     nfvoid = serializers.CharField(
-        help_text="nfvoid",
+        help_text="NFVO identification",
         max_length=255,
         required=True,
         allow_null=True)
     vnfmid = serializers.CharField(
-        help_text="vnfmid",
+        help_text="VNFM identification",
         max_length=255,
         required=True,
         allow_null=True)
     vimid = serializers.CharField(
-        help_text="vimid",
+        help_text="VIM identification that VNF belongs to",
         max_length=255,
         required=True,
         allow_null=True)
     tenant = serializers.CharField(
-        help_text="tenant",
+        help_text="The tenant that VNF belongs to",
         max_length=255,
         required=False,
         allow_blank=True)
     vnfinstanceid = serializers.CharField(
-        help_text="vnfinstanceid",
+        help_text="VNF instance identification",
         max_length=255,
         required=False,
         allow_null=True)
     operationright = serializers.CharField(
-        help_text="operationright",
+        help_text="VNF Operation right",
         max_length=255,
         required=False,
         allow_null=True)
     vmlist = GrantVmlistSerializer(
-        help_text='vmlist',
+        help_text='Virtual machines of the VNF instance',
         required=False,
         many=True)
     exvimidlist = serializers.ListSerializer(
-        help_text='exvimidlist',
+        help_text='Exclusive VIM identifications',
         child=serializers.CharField(allow_null=True),
         required=False)
 
 
 class GrantRespSerializer(serializers.Serializer):
     vimid = serializers.CharField(
-        help_text="vimid",
+        help_text="VIM identification",
         max_length=255,
         required=True,
         allow_null=True)
@@ -249,17 +249,17 @@ class GrantRespSerializer(serializers.Serializer):
 
 class VMIDlistSerializer(serializers.Serializer):
     VMID = serializers.CharField(
-        help_text="VMID",
+        help_text="Virtual machine identification",
         max_length=255,
         required=False,
         allow_null=True)
     VMName = serializers.CharField(
-        help_text="VMName",
+        help_text="Virtual machine name",
         max_length=255,
         required=False,
         allow_null=True)
     vimid = serializers.CharField(
-        help_text="vimid",
+        help_text="VIM identification",
         max_length=255,
         required=False,
         allow_null=True)
@@ -272,24 +272,24 @@ class VMIDlistSerializer(serializers.Serializer):
 
 class NotifyVmlistSerializer(serializers.Serializer):
     VMNumber = serializers.CharField(
-        help_text="VMNumber",
+        help_text="Virtual machine number",
         max_length=255,
         required=False,
         allow_null=True)
     vdutype = serializers.CharField(
-        help_text="vdutype",
+        help_text="Virtual deployment unit type",
         max_length=255,
         required=False,
         allow_null=True)
     VMFlavor = serializers.CharField(
-        help_text="VMFlavor",
+        help_text="Virtual machine flavor",
         max_length=255,
         required=False,
         allow_null=True)
     VMIDlist = serializers.ListSerializer(
-        help_text='VMIDlist',
+        help_text='Virtual machine identification list',
         child=VMIDlistSerializer(
-            help_text='VMIDlist',
+            help_text='Virtual machine identification',
             required=True,
             allow_null=True),
         required=False,
@@ -298,52 +298,52 @@ class NotifyVmlistSerializer(serializers.Serializer):
 
 class NotifyReqSerializer(serializers.Serializer):
     nfvoid = serializers.CharField(
-        help_text="nfvoid",
+        help_text="NFVO identification",
         max_length=255,
         required=True,
         allow_null=True)
     vnfmid = serializers.CharField(
-        help_text="vnfmid",
+        help_text="VNFM identification",
         max_length=255,
         required=True,
         allow_null=True)
     vimid = serializers.CharField(
-        help_text="vimid",
+        help_text="VIM identification",
         max_length=255,
         required=True,
         allow_null=True)
     timestamp = serializers.CharField(
-        help_text="timestamp",
+        help_text="Time stamp",
         max_length=255,
         required=False,
         allow_blank=True)
     vnfinstanceid = serializers.CharField(
-        help_text="vnfinstanceid",
+        help_text="VNF instance identification",
         max_length=255,
         required=False,
         allow_null=True)
     eventtype = serializers.CharField(
-        help_text="eventtype",
+        help_text="Event type",
         max_length=255,
         required=False,
         allow_null=True)
     vmlist = NotifyVmlistSerializer(
-        help_text='vmlist',
+        help_text='Virtual machine list',
         required=False,
         many=True)
     extension = serializers.DictField(
-        help_text="extension",
+        help_text="Extension",
         child=serializers.DictField(
             allow_null=True),
         required=False,
         allow_null=True)
     affectedcp = serializers.ListSerializer(
-        help_text='affectedcp',
+        help_text='Affected connected points',
         child=serializers.DictField(
             allow_null=True),
         required=False)
     affectedvirtuallink = serializers.ListSerializer(
-        help_text='affectedvirtuallink',
+        help_text='Affected virtual links',
         child=serializers.DictField(
             allow_null=True),
         required=False)
@@ -351,22 +351,22 @@ class NotifyReqSerializer(serializers.Serializer):
 
 class ScaleReqSerializer(serializers.Serializer):
     type = serializers.CharField(
-        help_text="type",
+        help_text="Scale type",
         max_length=255,
         required=True,
         allow_null=True)
     aspectId = serializers.CharField(
-        help_text="aspectId",
+        help_text="Scale aspectId",
         max_length=255,
         required=True,
         allow_null=True)
     numberOfSteps = serializers.CharField(
-        help_text="numberOfSteps",
+        help_text="The number of steps",
         max_length=255,
         required=True,
         allow_null=True)
     additionalParam = serializers.DictField(
-        help_text="additionalParam",
+        help_text="Additional parameters",
         child=serializers.DictField(
             allow_null=True),
         required=False,
@@ -375,32 +375,32 @@ class ScaleReqSerializer(serializers.Serializer):
 
 class AffectedvmSerializer(serializers.Serializer):
     extention = serializers.CharField(
-        help_text="extention",
+        help_text="Extension parameters",
         max_length=255,
         required=True,
         allow_blank=True)
     vmid = serializers.CharField(
-        help_text="vmid",
+        help_text="Virtual machine identification",
         max_length=255,
         required=True,
         allow_null=True)
     changtype = serializers.CharField(
-        help_text="changtype",
+        help_text="Chang type",
         max_length=255,
         required=True,
         allow_null=True)
     vduid = serializers.CharField(
-        help_text="vduid",
+        help_text="Virtual deployment unit identification",
         max_length=255,
         required=True,
         allow_null=True)
     vmname = serializers.CharField(
-        help_text="vmname",
+        help_text="Virtual machine name",
         max_length=255,
         required=True,
         allow_null=True)
     flavour = serializers.DictField(
-        help_text="flavour",
+        help_text="Virtual machine flavour",
         child=serializers.CharField(
             allow_blank=True),
         required=False,
@@ -409,24 +409,24 @@ class AffectedvmSerializer(serializers.Serializer):
 
 class HealReqSerializer(serializers.Serializer):
     action = serializers.CharField(
-        help_text="action",
+        help_text="Heal action",
         max_length=255,
         required=True,
         allow_null=False)
     lifecycleoperation = serializers.CharField(
-        help_text="lifecycleoperation",
+        help_text="Life cycle operation",
         max_length=255,
         required=True,
         allow_null=False)
     isgrace = serializers.CharField(
-        help_text="isgrace",
+        help_text="Whether the operation is grace or not",
         max_length=255,
         required=False,
         allow_null=True)
     affectedvm = serializers.ListSerializer(
-        help_text='affectedvm',
+        help_text='Affected virtual machine list',
         child=AffectedvmSerializer(
-            help_text='affectedvm',
+            help_text='Affected virtual machine',
             required=True,
             allow_null=True),
         required=True,
@@ -435,12 +435,12 @@ class HealReqSerializer(serializers.Serializer):
 
 class InstScaleHealRespSerializer(serializers.Serializer):
     jobId = serializers.CharField(
-        help_text="jobid",
+        help_text="The job identification",
         max_length=255,
         required=True,
         allow_null=True)
     vnfInstanceId = serializers.CharField(
-        help_text="nfInstanceId",
+        help_text="The vnf instance id",
         max_length=255,
         required=True,
         allow_null=True)
@@ -448,12 +448,12 @@ class InstScaleHealRespSerializer(serializers.Serializer):
 
 class SubscribeFilterSerializer(serializers.Serializer):
     vendor = serializers.CharField(
-        help_text="vendor",
+        help_text="The VNF vendor",
         max_length=255,
         required=True,
         allow_null=True)
     type = serializers.CharField(
-        help_text="type",
+        help_text="The subscription type",
         max_length=255,
         required=True,
         allow_null=True)
@@ -461,17 +461,17 @@ class SubscribeFilterSerializer(serializers.Serializer):
 
 class SubscribeSerializer(serializers.Serializer):
     subscribeid = serializers.CharField(
-        help_text="subscribeid",
+        help_text="Subscription identification",
         max_length=255,
         required=True,
         allow_null=True)
     notificationuri = serializers.CharField(
-        help_text="notificationuri",
+        help_text="The notification URI",
         max_length=255,
         required=True,
         allow_null=True)
     filter = SubscribeFilterSerializer(
-        help_text="filter",
+        help_text="The subscription filter",
         many=True,
         required=False,
         allow_null=True)
@@ -483,22 +483,22 @@ class SubscribesRespSerializer(serializers.Serializer):
 
 class SubscribeReqSerializer(serializers.Serializer):
     nfvoid = serializers.CharField(
-        help_text="nfvoid",
+        help_text="NFVO identification",
         max_length=255,
         required=True,
         allow_null=True)
     vnfmid = serializers.CharField(
-        help_text="vnfmid",
+        help_text="VNFM identification",
         max_length=255,
         required=True,
         allow_null=True)
     notificationuri = serializers.CharField(
-        help_text="notificationuri",
+        help_text="The Notification URI",
         max_length=255,
         required=True,
         allow_null=True)
     filter = SubscribeFilterSerializer(
-        help_text="filter",
+        help_text="The subscription filter",
         many=True,
         required=False,
         allow_null=True)
@@ -506,7 +506,7 @@ class SubscribeReqSerializer(serializers.Serializer):
 
 class SubscribeRespSerializer(serializers.Serializer):
     subscribeid = serializers.CharField(
-        help_text="subscribeid",
+        help_text="The subscription identification",
         max_length=255,
         required=True,
         allow_null=True)
@@ -514,41 +514,41 @@ class SubscribeRespSerializer(serializers.Serializer):
 
 class VnfPkgSerializer(serializers.Serializer):
     packageid = serializers.CharField(
-        help_text="packageid",
+        help_text="The package identification",
         max_length=255,
         required=False,
         allow_null=True)
     vendor = serializers.CharField(
-        help_text="vendor",
+        help_text="The VNF vendor",
         max_length=255,
         required=False,
         allow_null=True)
     type = serializers.CharField(
-        help_text="type",
+        help_text="THe VNF package type",
         max_length=255,
         required=False,
         allow_null=True)
     vnfdfile = serializers.CharField(
-        help_text="vnfdfile",
+        help_text="The VNFD file",
         max_length=255,
         required=False,
         allow_null=True)
     imagefiles = serializers.ListSerializer(
-        help_text='imagefiles',
+        help_text='The image file list',
         child=serializers.CharField(
-            help_text='imagefile',
+            help_text='The image file',
             required=True),
         required=False,
         allow_null=True)
     swfiles = serializers.ListSerializer(
-        help_text='swfiles',
+        help_text='The software file list',
         child=serializers.CharField(
-            help_text='swfile',
+            help_text='THe software file',
             required=True),
         required=False,
         allow_null=True)
     description = serializers.CharField(
-        help_text="description",
+        help_text="The VNF package description",
         max_length=255,
         required=False,
         allow_null=True)
@@ -556,7 +556,7 @@ class VnfPkgSerializer(serializers.Serializer):
 
 class VnfPkgsSerializer(serializers.Serializer):
     data = VnfPkgSerializer(
-        help_text="Vnf package",
+        help_text="The vnf package",
         many=True,
         required=False,
         allow_null=True)
@@ -564,17 +564,17 @@ class VnfPkgsSerializer(serializers.Serializer):
 
 class NfvoInfoReqSerializer(serializers.Serializer):
     nfvoid = serializers.CharField(
-        help_text="nfvoid",
+        help_text="NFVO identification",
         max_length=255,
         required=False,
         allow_null=True)
     vnfmid = serializers.CharField(
-        help_text="nfvoid",
+        help_text="VNFM identification",
         max_length=255,
         required=False,
         allow_null=True)
     nfvourl = serializers.CharField(
-        help_text="nfvoid",
+        help_text="NFVO URL",
         max_length=255,
         required=False,
         allow_null=True)