Add serializer check for job query interface
[vfc/nfvo/lcm.git] / lcm / jobs / serializers.py
1 # Copyright 2018 ZTE Corporation.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 #         http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 from rest_framework import serializers
16
17
18 class JobHistorySerializer(serializers.Serializer):
19     status = serializers.CharField(help_text="Status of job", required=True)
20     progress = serializers.CharField(help_text="Progress of job", required=True)
21     statusDescription = serializers.CharField(help_text="Description of job", required=False, allow_null=True)
22     errorCode = serializers.CharField(help_text="Error code of job", required=False, allow_null=True)
23     responseId = serializers.CharField(help_text="Response index of job", required=True)
24
25
26 class JobDescriptorSerializer(serializers.Serializer):
27     status = serializers.CharField(help_text="Status of job", required=True)
28     # progress = serializers.CharField(help_text="Progress of job", required=True)
29     progress = serializers.IntegerField(help_text="Progress of job", required=True)
30     statusDescription = serializers.CharField(help_text="Description of job", required=False, allow_null=True)
31     errorCode = serializers.CharField(help_text="Error code of job", required=False, allow_null=True)
32     responseId = serializers.CharField(help_text="Response index of job", required=True)
33     responseHistoryList = JobHistorySerializer(help_text="History of job", many=True)
34
35
36 class JobQueryRespSerializer(serializers.Serializer):
37     jobId = serializers.CharField(help_text="UUID of job", required=True)
38     responseDescriptor = JobDescriptorSerializer(help_text="Descriptor of job", required=False)
39
40
41 class JobUpdReqSerializer(serializers.Serializer):
42     progress = serializers.CharField(help_text="Progress of job", required=True)
43     desc = serializers.CharField(help_text="Desc of job", required=False)
44     errcode = serializers.CharField(help_text="Error code of job", required=False)
45
46
47 class JobUpdRespSerializer(serializers.Serializer):
48     result = serializers.CharField(help_text="Result of job update", required=True)
49     msg = serializers.CharField(help_text="Detail of job update", required=False)