Change API layer for NSI selection
[optf/osdf.git] / apps / slice_selection / models / api / nsi_selection_response.py
1 # -------------------------------------------------------------------------
2 #   Copyright (C) 2020 Wipro Limited.
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 #
18
19 from osdf.models.api.common import OSDFModel
20 from schematics.types import BaseType, StringType, BooleanType
21 from schematics.types.compound import ModelType, ListType, DictType
22
23
24 # TODO: update osdf.models
25 class SharedNSISolution(OSDFModel):
26     """Represents the shared NSI Solution object"""
27     invariantUUID = StringType(required=True)
28     UUID = StringType(required=True)
29     NSIName = StringType(required=True)
30     NSIId = StringType(required=True)
31     matchLevel = StringType(required=True)
32
33
34 class NewNSISolution(OSDFModel):
35     """Represents the New NSI Solution object containing tuple of slice profiles"""
36     sliceProfiles = ListType(DictType(BaseType), required=True)
37     matchLevel = StringType(required=True)
38
39
40 class NSISolution(OSDFModel):
41     """Represents the NSI Solution object"""
42     """This solution object contains either sharedNSISolution or newNSISolution"""
43     existingNSI = BooleanType(required=True)
44     sharedNSISolution = ModelType(SharedNSISolution)
45     newNSISolution = ModelType(NewNSISolution)
46
47
48 class NSISelectionResponse(OSDFModel):
49     """Response sent to NSMF(SO)"""
50     transactionId = StringType(required=True)
51     requestId = StringType(required=True)
52     requestStatus = StringType(required=True)
53     solutions = ListType(ModelType(NSISolution), required=True)
54     statusMessage = StringType()