fix AffectedSapsSerializer description error
[vfc/nfvo/lcm.git] / lcm / ns / serializers / sol / affected_saps.py
1 # Copyright (c) 2019, CMCC Technologies Co., Ltd.
2 # Copyright 2019 ZTE Corporation.
3
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
7
8 # http://www.apache.org/licenses/LICENSE-2.0
9
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
15
16
17 from rest_framework import serializers
18
19 from lcm.ns import const
20
21
22 CHANGE_TYPE = [
23     const.CHANGE_TYPES.ADD,
24     const.CHANGE_TYPES.REMOVE,
25     const.CHANGE_TYPES.MODIFY
26 ]
27
28 CHANGE_RESULT = [
29     const.CHANGE_RESULTS.COMPLETED,
30     const.CHANGE_RESULTS.ROLLED_BACK,
31     const.CHANGE_RESULTS.FAILED
32 ]
33
34
35 class AffectedSapsSerializer(serializers.Serializer):
36     sapInstanceId = serializers.UUIDField(
37         help_text="Identifier of the SAP instance.",
38         required=True
39     )
40     sapdId = serializers.UUIDField(
41         help_text="Identifier of the SAPD for this SAP.",
42         required=True
43     )
44     sapName = serializers.CharField(
45         help_text="Human readable name for the SAP.",
46         required=True)
47     changeType = serializers.ChoiceField(
48         help_text="Signals the type of lifecycle change",
49         required=True,
50         choices=CHANGE_TYPE
51     )
52     changeResult = serializers.ChoiceField(
53         help_text="Signals the result of change identified by the 'changeType' attribute.",
54         required=True,
55         choices=CHANGE_RESULT
56     )