Docs: Add API docs from swagger json file; Add user guide document
[pti/o2.git] / o2ims / views / provision_dto.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 flask_restx import fields
16
17 from o2ims.views.api_ns import api_provision_v1
18
19
20 class SmoEndpointDTO:
21
22     endpoint_get = api_provision_v1.model(
23         "SmoEndpointGetDto",
24         {
25             'id': fields.String(required=True,
26                                 description='SMO Endpoint Configuration ID'),
27             'endpoint': fields.String,
28             'status': fields.String,
29             'comments': fields.String,
30         }
31     )
32
33     endpoint = api_provision_v1.model(
34         "SmoEndpointCreateDto",
35         {
36             'endpoint': fields.String(
37                 required=True,
38                 description='Configuration SMO callback address',
39                 example='http://mock_smo:80/registration')
40         }
41     )
42
43     endpoint_post_resp = api_provision_v1.model(
44         "SmoEndpointCreatedRespDto",
45         {
46             'id': fields.String(required=True,
47                                 description='SMO Endpoint Configuration ID'),
48         }
49     )