RIC-641 Fixing client/server model definitions and adding client and server API
[ric-plt/xapp-frame-cpp.git] / src / model / SubscriptionParams.h
1 /*
2 # ==================================================================================
3 # Copyright (c) 2020 HCL Technologies Limited.
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16 # ==================================================================================
17 */
18 #ifndef XAPP_MODEL_SubscriptionParams_H
19 #define XAPP_MODEL_SubscriptionParams_H
20 #include"SubscriptionDetail.h"
21 #include"SubscriptionParams_ClientEndpoint.h"
22 #include"SubscriptionParams_E2SubscriptionDirectives.h"
23
24 namespace xapp
25
26 {
27         namespace model {
28
29                 struct SubscriptionParams:public ModelBase {
30
31                         std::string Host{ "" };
32                         int HTTPPort{ 0 };
33                         int RMRPort{ 0 };
34                         SubscriptionParams_ClientEndpoint ClientEndpoint;
35                         std::string Meid{ "" };
36                         int RANFunctionID{ 0 };
37                         std::string SubscriptionId{ "" };
38                         std::vector<SubscriptionDetail> Data;
39                         SubscriptionParams_E2SubscriptionDirectives E2SubscriptionDirectives;
40
41                         nlohmann::json validator_schema = R"(
42                         {
43                         "$schema": "http://json-schema.org/draft-07/schema#",
44                         "title": "SubscriptionParams",
45                         "properties": {
46                             "SubscriptionId": {
47                                 "description": "Optional subscription ID '(Submgr allocates if not given)'",
48                                 "type": "string"
49                             },
50                             "Meid": {
51                                 "type": "string"
52                             },
53                             "RANFunctionID": {
54                                 "type": "integer",
55                                 "minimum": 0,
56                                 "maximum": 4095
57                             },
58                                 "ClientEndpoint":{
59                                         "type": "object"
60                                 },
61                                 "E2SubscriptionDirectives":{
62                                         "type": "object"
63                                 },
64                                 "SubscriptionDetails":{
65                                         "type": "array"
66                                 }
67                         },
68                         "required": [
69                                      "ClientEndpoint",
70                                      "Meid",
71                                      "RANFunctionID",
72                                      "SubscriptionDetails"
73                                     ],
74                         "type": "object"
75                         })"_json;
76
77                         virtual nlohmann::json get_validator_schema() const { return validator_schema; }
78                 };
79                 void from_json(const nlohmann::json& j, SubscriptionParams& ref);
80                 void to_json(nlohmann::json& j, const SubscriptionParams& ref);
81
82
83         }
84 }
85 #endif /*XAPP_MODEL_SubscriptionParams_H*/