Docs: Add API docs from swagger json file; Add user guide document
[pti/o2.git] / o2ims / domain / configuration_obj.py
1 # Copyright (C) 2021 Wind River Systems, Inc.
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 __future__ import annotations
16 from enum import Enum
17 # from dataclasses import dataclass
18
19 from o2common.domain.base import AgRoot, Serializer
20
21
22 class RegistrationStatusEnum(str, Enum):
23     CREATED = 'CREATED'
24     NOTIFIED = 'NOTIFIED'
25     FAILED = 'FAILED'
26
27
28 class ConfigurationTypeEnum(str, Enum):
29     SMO = 'SMO'
30
31
32 class Configuration(AgRoot, Serializer):
33     def __init__(self, id: str, url: str,
34                  conf_type: ConfigurationTypeEnum,
35                  status: RegistrationStatusEnum =
36                  RegistrationStatusEnum.CREATED,
37                  comments: str = '') -> None:
38         super().__init__()
39         self.configurationId = id
40         self.conftype = conf_type
41         self.callback = url
42         self.status = status
43         self.comments = comments
44
45     def serialize_smo(self):
46         if self.conftype != ConfigurationTypeEnum.SMO:
47             return
48
49         d = Serializer.serialize(self)
50
51         d['endpoint'] = d['callback']
52         d['id'] = d['configurationId']
53         return d