Add grant vnf swagger generate logic
[vfc/nfvo/lcm.git] / lcm / ns / vnfs / 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 InstVnfReqSerializer(serializers.Serializer):
19     vnfIndex = serializers.CharField(help_text="Index of VNF", required=True)
20     nsInstanceId = serializers.CharField(help_text="ID of NS instance", required=True)
21     additionalParamForVnf = serializers.CharField(help_text="Additional param for VNF", required=False, allow_null=True)
22
23
24 class InstVnfRespSerializer(serializers.Serializer):
25     vnfInstId = serializers.CharField(help_text="ID of VNF instance", required=True)
26     jobId = serializers.CharField(help_text="ID of Job", required=True)
27
28
29 class GetVnfRespSerializer(serializers.Serializer):
30     vnfInstId = serializers.CharField(help_text="ID of VNF instance", required=True)
31     vnfName = serializers.CharField(help_text="Name of VNF instance", required=True)
32     vnfStatus = serializers.CharField(help_text="Status of VNF instance", required=True)
33
34
35 class TerminateVnfReqSerializer(serializers.Serializer):
36     terminationType = serializers.CharField(help_text="Termination Type", required=False, allow_null=True)
37     gracefulTerminationTimeout = serializers.CharField(help_text="Graceful Termination Timeout", required=False, allow_null=True)
38
39
40 class TerminateVnfRespSerializer(serializers.Serializer):
41     jobId = serializers.CharField(help_text="ID of Job", required=True)
42
43
44 class ResourceChangeSerializer(serializers.Serializer):
45     type = serializers.ChoiceField(help_text="Change Type", choices=["VDU"], required=True)
46     resourceDefinitionId = serializers.CharField(help_text="Identifier of resource", required=False, allow_null=True)
47     vdu = serializers.CharField(help_text="Identifier identifier of VDU", required=False, allow_null=True)
48
49
50 class GrantVnfReqSerializer(serializers.Serializer):
51     vnfInstanceId = serializers.CharField(help_text="ID of VNF instance", required=True)
52     vnfDescriptorId = serializers.CharField(help_text="ID of VNF Descriptor", required=False, allow_null=True)
53     lifecycleOperation = serializers.ChoiceField(
54         help_text="Lifecycle Operation",
55         choices=["Terminal", "Instantiate", "Scalein", "Scaleout", "Scaledown", "Scaleup", "Heal"],
56         required=True
57     )
58     jobId = serializers.CharField(help_text="ID of Job", required=False, allow_null=True)
59     addResource = ResourceChangeSerializer(help_text="Add resources", many=True)
60     removeResource = ResourceChangeSerializer(help_text="Remove resources", many=True)
61     additionalParam = serializers.DictField(
62         help_text="Additional parameters passed to the NFVO, specific to the VNF and the LCM operation. The currently interpreted keys are the following: vimId",
63         child=serializers.CharField(help_text="Additional parameters", allow_blank=True),
64         required=False,
65         allow_null=True
66     )
67
68
69 class AccessinfoSerializer(serializers.Serializer):
70     tenant = serializers.CharField(help_text="Name of tenant", required=True)
71
72
73 class VimSerializer(serializers.Serializer):
74     vimid = serializers.CharField(help_text="ID of VIM", required=True)
75     accessinfo = AccessinfoSerializer(help_text="Access Info", required=True)
76
77
78 class GrantVnfRespSerializer(serializers.Serializer):
79     vnfInstanceId = serializers.CharField(help_text="ID of VNF instance", required=False, allow_null=True)
80     vim = VimSerializer(help_text="VIM Info", required=True)