1 # Copyright (C) 2021 Wind River Systems, Inc.
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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.
15 from flask import jsonify
16 from flask_restx import Resource
18 from o2ims import config
19 from o2ims.views import ocloud_view
20 from o2ims.views.ocloud_dto import OcloudDTO, ResourceTypeDTO,\
21 ResourcePoolDTO, ResourceDTO, DeploymentManagerDTO, SubscriptionDTO
23 apibase = config.get_o2ims_api_base()
24 # api = Namespace("O2IMS", description='IMS')
27 # ---------- OClouds ---------- #
28 api_ocloud = OcloudDTO.api
31 @api_ocloud.route("/")
32 class OcloudsListRouter(Resource):
33 """Ocloud get endpoint
34 O2 interface ocloud endpoint
37 ocloud_get = OcloudDTO.ocloud_list
39 @api_ocloud.marshal_list_with(ocloud_get)
41 return ocloud_view.oclouds(uow)
44 # ---------- ResourceTypes ---------- #
45 api_rt = ResourceTypeDTO.api
48 @api_rt.route("/resourceTypes")
49 class ResourceTypesListRouter(Resource):
51 model = ResourceTypeDTO.resource_type_get
53 @api_rt.marshal_list_with(model)
55 return ocloud_view.resource_types(uow)
57 # @api.doc(response={405: 'Method Not Allowed'})
61 # @api.doc(response={405: 'Method Not Allowed'})
65 # @api.doc(response={405: 'Method Not Allowed'})
69 # @api.doc(response={405: 'Method Not Allowed'})
74 @api_rt.route("/resourceTypes/<resourceTypeID>")
75 @api_rt.param('resourceTypeID', 'ID of the resource type')
76 @api_rt.response(404, 'Resource type not found')
77 class ResourceTypeGetRouter(Resource):
79 model = ResourceTypeDTO.resource_type_get
81 @api_rt.doc('Get resource type')
82 @api_rt.marshal_with(model)
83 def get(self, resourceTypeID):
84 result = ocloud_view.resource_type_one(resourceTypeID, uow)
85 if result is not None:
88 404, "Resource type {} doesn't exist".format(resourceTypeID))
91 # ---------- ResourcePools ---------- #
92 api_rp = ResourcePoolDTO.api
95 @api_rp.route("/resourcePools")
96 class ResourcePoolsListRouter(Resource):
98 model = ResourcePoolDTO.resource_pool_get
100 @api_rp.marshal_list_with(model)
102 return ocloud_view.resource_pools(uow)
105 @api_rp.route("/resourcePools/<resourcePoolID>")
106 @api_rp.param('resourcePoolID', 'ID of the resource pool')
107 @api_rp.response(404, 'Resource pool not found')
108 class ResourcePoolGetRouter(Resource):
110 model = ResourcePoolDTO.resource_pool_get
112 @api_rp.doc('Get resource pool')
113 def get(self, resourcePoolID):
114 result = ocloud_view.resource_pool_one(resourcePoolID, uow)
115 if result is not None:
118 404, "Resource pool {} doesn't exist".format(resourcePoolID))
121 # ---------- Resources ---------- #
122 api_res = ResourceDTO.api
125 @api_res.route("/resourcePools/<resourcePoolID>/resources")
126 @api_res.param('resourcePoolID', 'ID of the resource pool')
127 class ResourcesListRouter(Resource):
129 model = ResourceDTO.resource_list
131 @api_res.marshal_list_with(model)
132 def get(self, resourcePoolID):
133 return ocloud_view.resources(resourcePoolID, uow)
136 @api_res.route("/resourcePools/<resourcePoolID>/resources/<resourceID>")
137 @api_res.param('resourcePoolID', 'ID of the resource pool')
138 @api_res.param('resourceID', 'ID of the resource')
139 @api_res.response(404, 'Resource not found')
140 class ResourceGetRouter(Resource):
142 model = ResourceDTO.resource_get
144 @api_res.doc('Get resource')
145 def get(self, resourcePoolID, resourceID):
146 result = ocloud_view.resource_one(resourceID, uow)
147 if result is not None:
149 api_res.abort(404, "Resource {} doesn't exist".format(resourceID))
152 # ---------- DeploymentManagers ---------- #
153 api_dm = DeploymentManagerDTO.api
156 @api_dm.route("/deploymentManagers")
157 class DeploymentManagersListRouter(Resource):
159 model = DeploymentManagerDTO.deployment_manager_get
161 @api_dm.marshal_list_with(model)
163 return ocloud_view.deployment_managers(uow)
166 @api_dm.route("/deploymentManagers/<deploymentManagerID>")
167 @api_dm.param('deploymentManagerID', 'ID of the deployment manager')
168 @api_dm.response(404, 'Deployment manager not found')
169 class DeploymentManagerGetRouter(Resource):
171 model = DeploymentManagerDTO.deployment_manager_get
173 @api_dm.doc('Get deployment manager')
174 def get(self, deploymentManagerID):
175 result = ocloud_view.deployment_manager_one(
176 deploymentManagerID, uow)
177 if result is not None:
179 api_dm.abort(404, "Deployment manager {} doesn't exist".format(
180 deploymentManagerID))
183 # ---------- Subscriptions ---------- #
184 api_sub = SubscriptionDTO.api
187 @api_sub.route("/subscriptions")
188 class SubscriptionsListRouter(Resource):
190 model = SubscriptionDTO.subscription_get
192 @api_sub.marshal_list_with(model)
194 return ocloud_view.subscriptions(uow)
197 @api_sub.route("/subscriptions/<subscriptionID>")
198 @api_sub.param('subscriptionID', 'ID of the subscription')
199 @api_sub.response(404, 'Subscription not found')
200 class SubscriptionGetRouter(Resource):
202 model = DeploymentManagerDTO.deployment_manager_get
204 @api_sub.doc('Get subscription by ID')
205 def get(self, subscriptionID):
206 result = ocloud_view.subscription_one(
208 if result is not None:
210 api_sub.abort(404, "Subscription {} doesn't exist".format(
214 def configure_namespace(app, bus):
216 app.add_namespace(api_ocloud, path=apibase)
217 app.add_namespace(api_rt, path=apibase)
218 app.add_namespace(api_rp, path=apibase)
219 app.add_namespace(api_res, path=apibase)
220 app.add_namespace(api_dm, path=apibase)
221 app.add_namespace(api_sub, path=apibase)
228 def configure_routes(app, bus):
230 # ---------- OClouds ---------- #
231 @app.route(apibase, methods=["GET"])
233 result = ocloud_view.oclouds(bus.uow)
234 return jsonify(result), 200
236 # ---------- ResourceTypes ---------- #
238 @app.route(apibase + "/resourceTypes", methods=["GET"])
239 def resource_types():
240 result = ocloud_view.resource_types(bus.uow)
241 return jsonify(result), 200
243 @app.route(apibase + "/resourceTypes", methods=["POST", "PUT", "PATCH",
245 def resource_types_not_allow():
246 return "Method Not Allowed", 405
248 @app.route(apibase + "/resourceTypes/<resourceTypeID>", methods=["GET"])
249 def resource_types_one(resourceTypeID):
250 result = ocloud_view.resource_type_one(resourceTypeID, bus.uow)
253 return jsonify(result), 200
255 @app.route(apibase + "/resourceTypes/<resourceTypeID>",
256 methods=["POST", "PUT", "PATCH", "DELETE"])
257 def resource_types_one_not_allow(resourceTypeID):
258 return "Method Not Allowed", 405
260 # ---------- ResourcePools ---------- #
262 @app.route(apibase + "/resourcePools", methods=["GET"])
263 def resource_pools():
264 result = ocloud_view.resource_pools(bus.uow)
265 return jsonify(result), 200
267 @app.route(apibase + "/resourcePools", methods=["POST", "PUT", "PATCH",
269 def resource_pools_not_allow():
270 return "Method Not Allowed", 405
272 @app.route(apibase + "/resourcePools/<resourcePoolID>", methods=["GET"])
273 def resource_pools_one(resourcePoolID):
274 result = ocloud_view.resource_pool_one(resourcePoolID, bus.uow)
277 return jsonify(result), 200
279 @app.route(apibase + "/resourcePools/<resourcePoolID>",
280 methods=["POST", "PUT", "PATCH", "DELETE"])
281 def resource_pools_one_not_allow(resourcePoolID):
282 return "Method Not Allowed", 405
284 # ---------- Resources ---------- #
286 @app.route(apibase + "/resourcePools/<resourcePoolID>/resources",
288 def resources(resourcePoolID):
289 result = ocloud_view.resources(resourcePoolID, bus.uow)
290 return jsonify(result), 200
292 @app.route(apibase + "/resourcePools/<resourcePoolID>/resources",
293 methods=["POST", "PUT", "PATCH", "DELETE"])
294 def resource_not_allow(resourcePoolID):
295 return "Method Not Allowed", 405
298 "/resourcePools/<resourcePoolID>/resources/<resourceID>",
300 def resources_one(resourcePoolID, resourceID):
301 result = ocloud_view.resource_one(resourceID, bus.uow)
304 return jsonify(result), 200
307 "/resourcePools/<resourcePoolID>/resources/<resourceID>",
308 methods=["POST", "PUT", "PATCH", "DELETE"])
309 def resource_one_not_allow(resourcePoolID, resourceID):
310 return "Method Not Allowed", 405
312 # ---------- DeploymentManagers ---------- #
314 @app.route(apibase + "/deploymentManagers", methods=["GET"])
315 def deployment_managers():
316 result = ocloud_view.deployment_managers(bus.uow)
317 return jsonify(result), 200
319 @app.route(apibase + "/deploymentManagers",
320 methods=["POST", "PUT", "PATCH", "DELETE"])
321 def deployment_managers_not_allow():
322 return "Method Not Allowed", 405
324 @app.route(apibase + "/deploymentManagers/<deploymentManagerID>",
326 def deployment_manager_one(deploymentManagerID):
327 result = ocloud_view.deployment_manager_one(
328 deploymentManagerID, bus.uow)
331 return jsonify(result), 200
333 @app.route(apibase + "/deploymentManagers/<deploymentManagerID>",
334 methods=["POST", "PUT", "PATCH", "DELETE"])
335 def deployment_manager_one_not_allow(deploymentManagerID):
336 return "Method Not Allowed", 405