X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=o2ims%2Fviews%2Focloud_route.py;h=8b0ccf590e7768b31ac8c90c2fbad644aac2cc70;hb=refs%2Fchanges%2F17%2F9917%2F1;hp=26da34c20db199b438328b93e35b50cae446e4a8;hpb=7e4dd62aa6df26c97dc2596bacacedebb16f7e13;p=pti%2Fo2.git diff --git a/o2ims/views/ocloud_route.py b/o2ims/views/ocloud_route.py index 26da34c..8b0ccf5 100644 --- a/o2ims/views/ocloud_route.py +++ b/o2ims/views/ocloud_route.py @@ -17,8 +17,11 @@ from flask_restx import Resource, reqparse from o2common.service.messagebus import MessageBus from o2common.views.pagination_route import link_header, PAGE_PARAM +from o2common.views.route_exception import NotFoundException, \ + BadRequestException +from o2ims.domain import ocloud from o2ims.views import ocloud_view -from o2ims.views.api_ns import api_ims_inventory_v1 +from o2ims.views.api_ns import api_ims_inventory as api_ims_inventory_v1 from o2ims.views.ocloud_dto import OcloudDTO, ResourceTypeDTO,\ ResourcePoolDTO, ResourceDTO, DeploymentManagerDTO, SubscriptionDTO @@ -32,8 +35,23 @@ def configure_api_route(): bus = MessageBus.get_instance() +# ---------- API versions ---------- # +@api_ims_inventory_v1.route("/v1/api_versions") +class VersionRouter(Resource): + @api_ims_inventory_v1.doc('Get Inventory API version') + def get(self): + return { + 'uriPrefix': request.base_url.rsplit('/', 1)[0], + 'apiVersions': [{ + 'version': '1.0.0', + # 'isDeprecated': 'False', + # 'retirementDate': '' + }] + } + + # ---------- OClouds ---------- # -@api_ims_inventory_v1.route("/") +@api_ims_inventory_v1.route(*["/v1", "/v1/"]) @api_ims_inventory_v1.response(404, 'oCloud not found') @api_ims_inventory_v1.param( 'all_fields', @@ -62,17 +80,17 @@ class OcloudsListRouter(Resource): ocloud_get = OcloudDTO.ocloud + @api_ims_inventory_v1.doc('Get Ocloud Information') @api_ims_inventory_v1.marshal_with(ocloud_get) def get(self): res = ocloud_view.oclouds(bus.uow) if len(res) > 0: return res[0] - api_ims_inventory_v1.abort( - 404, "oCloud doesn't exist") + raise NotFoundException("oCloud doesn't exist") # ---------- ResourceTypes ---------- # -@api_ims_inventory_v1.route("/resourceTypes") +@api_ims_inventory_v1.route("/v1/resourceTypes") @api_ims_inventory_v1.param(PAGE_PARAM, 'Page number of the results to fetch.' + ' Default: 1', @@ -105,6 +123,7 @@ class ResourceTypesListRouter(Resource): model = ResourceTypeDTO.resource_type_get + @api_ims_inventory_v1.doc('Get Resource Type List') @api_ims_inventory_v1.marshal_list_with(model) def get(self): parser = reqparse.RequestParser() @@ -120,7 +139,7 @@ class ResourceTypesListRouter(Resource): return link_header(request.full_path, ret) -@api_ims_inventory_v1.route("/resourceTypes/") +@api_ims_inventory_v1.route("/v1/resourceTypes/") @api_ims_inventory_v1.param('resourceTypeID', 'ID of the resource type') @api_ims_inventory_v1.response(404, 'Resource type not found') @api_ims_inventory_v1.param( @@ -147,18 +166,18 @@ class ResourceTypeGetRouter(Resource): model = ResourceTypeDTO.resource_type_get - @api_ims_inventory_v1.doc('Get resource type') + @api_ims_inventory_v1.doc('Get Resource Type Information') @api_ims_inventory_v1.marshal_with(model) def get(self, resourceTypeID): result = ocloud_view.resource_type_one(resourceTypeID, bus.uow) - if result is not None: - return result - api_ims_inventory_v1.abort( - 404, "Resource type {} doesn't exist".format(resourceTypeID)) + if not result: + raise NotFoundException("Resource type {} doesn't exist".format( + resourceTypeID)) + return result # ---------- ResourcePools ---------- # -@api_ims_inventory_v1.route("/resourcePools") +@api_ims_inventory_v1.route("/v1/resourcePools") @api_ims_inventory_v1.param(PAGE_PARAM, 'Page number of the results to fetch.' + ' Default: 1', @@ -191,6 +210,7 @@ class ResourcePoolsListRouter(Resource): model = ResourcePoolDTO.resource_pool_get + @api_ims_inventory_v1.doc('Get Resource Pool List') @api_ims_inventory_v1.marshal_list_with(model) def get(self): parser = reqparse.RequestParser() @@ -206,7 +226,7 @@ class ResourcePoolsListRouter(Resource): return link_header(request.full_path, ret) -@api_ims_inventory_v1.route("/resourcePools/") +@api_ims_inventory_v1.route("/v1/resourcePools/") @api_ims_inventory_v1.param('resourcePoolID', 'ID of the resource pool') @api_ims_inventory_v1.response(404, 'Resource pool not found') @api_ims_inventory_v1.param( @@ -233,19 +253,20 @@ class ResourcePoolGetRouter(Resource): model = ResourcePoolDTO.resource_pool_get - @api_ims_inventory_v1.doc('Get resource pool') + @api_ims_inventory_v1.doc('Get Resource Pool Information') @api_ims_inventory_v1.marshal_with(model) def get(self, resourcePoolID): result = ocloud_view.resource_pool_one(resourcePoolID, bus.uow) if result is not None: return result - api_ims_inventory_v1.abort( - 404, "Resource pool {} doesn't exist".format(resourcePoolID)) + raise NotFoundException("Resource pool {} doesn't exist".format( + resourcePoolID)) # ---------- Resources ---------- # -@api_ims_inventory_v1.route("/resourcePools//resources") +@api_ims_inventory_v1.route("/v1/resourcePools//resources") @api_ims_inventory_v1.param('resourcePoolID', 'ID of the resource pool') +@api_ims_inventory_v1.response(404, 'Resource pool not found') # @api_ims_inventory_v1.param('sort', 'sort by column name', # _in='query') # @api_ims_inventory_v1.param('per_page', 'The number of results per page ' + @@ -283,6 +304,7 @@ class ResourcesListRouter(Resource): model = ResourceDTO.resource_list + @api_ims_inventory_v1.doc('Get Resource List') @api_ims_inventory_v1.marshal_list_with(model) def get(self, resourcePoolID): parser = reqparse.RequestParser() @@ -296,13 +318,15 @@ class ResourcesListRouter(Resource): if args.nextpage_opaque_marker is not None: kwargs['page'] = args.nextpage_opaque_marker kwargs['filter'] = args.filter if args.filter is not None else '' - ret = ocloud_view.resources(resourcePoolID, bus.uow, **kwargs) + if ret is None: + raise NotFoundException("Resources under {} doesn't exist".format( + resourcePoolID)) return link_header(request.full_path, ret) @api_ims_inventory_v1.route( - "/resourcePools//resources/") + "/v1/resourcePools//resources/") @api_ims_inventory_v1.param('resourcePoolID', 'ID of the resource pool') @api_ims_inventory_v1.param('resourceID', 'ID of the resource') @api_ims_inventory_v1.response(404, 'Resource not found') @@ -332,18 +356,18 @@ class ResourceGetRouter(Resource): # model = dto.get_resource_get() model = ResourceDTO.recursive_resource_mapping() - @api_ims_inventory_v1.doc('Get resource') + @api_ims_inventory_v1.doc('Get Resource Information') @api_ims_inventory_v1.marshal_with(model) def get(self, resourcePoolID, resourceID): - result = ocloud_view.resource_one(resourceID, bus.uow) - if result is not None: - return result - api_ims_inventory_v1.abort( - 404, "Resource {} doesn't exist".format(resourceID)) + result = ocloud_view.resource_one(resourceID, bus.uow, resourcePoolID) + if result is None: + raise NotFoundException("Resource {} doesn't exist".format( + resourceID)) + return result # ---------- DeploymentManagers ---------- # -@api_ims_inventory_v1.route("/deploymentManagers") +@api_ims_inventory_v1.route("/v1/deploymentManagers") @api_ims_inventory_v1.param(PAGE_PARAM, 'Page number of the results to fetch.' + ' Default: 1', @@ -376,6 +400,7 @@ class DeploymentManagersListRouter(Resource): model = DeploymentManagerDTO.deployment_manager_list + @api_ims_inventory_v1.doc('Get Deployment Manager List') @api_ims_inventory_v1.marshal_list_with(model) def get(self): parser = reqparse.RequestParser() @@ -391,11 +416,12 @@ class DeploymentManagersListRouter(Resource): return link_header(request.full_path, ret) -@api_ims_inventory_v1.route("/deploymentManagers/") +@api_ims_inventory_v1.route("/v1/deploymentManagers/") @api_ims_inventory_v1.param('deploymentManagerID', 'ID of the deployment manager') -@api_ims_inventory_v1.param('profile', 'DMS profile: value supports "sol018"', - _in='query') +@api_ims_inventory_v1.param( + 'profile', 'DMS profile: value supports "native_k8sapi"', + _in='query') @api_ims_inventory_v1.response(404, 'Deployment manager not found') @api_ims_inventory_v1.param( 'all_fields', @@ -421,7 +447,7 @@ class DeploymentManagerGetRouter(Resource): model = DeploymentManagerDTO.deployment_manager_get - @api_ims_inventory_v1.doc('Get deployment manager') + @api_ims_inventory_v1.doc('Get Deployment Manager Information') @api_ims_inventory_v1.marshal_with(model) def get(self, deploymentManagerID): parser = reqparse.RequestParser() @@ -429,25 +455,28 @@ class DeploymentManagerGetRouter(Resource): args = parser.parse_args() profile = ( args.profile if args.profile is not None and args.profile != '' - else 'default') + else ocloud.DeploymentManagerProfileDefault) result = ocloud_view.deployment_manager_one( deploymentManagerID, bus.uow, profile) - if result is not None: + if result is not None and result != "": return result - api_ims_inventory_v1.abort( - 404, - "Deployment manager {} doesn't exist".format(deploymentManagerID)) + elif result == "": + raise NotFoundException( + "Profile {} doesn't support".format( + args.profile)) + + raise NotFoundException("Deployment manager {} doesn't exist".format( + deploymentManagerID)) # ---------- Subscriptions ---------- # -@api_ims_inventory_v1.route("/subscriptions") +@api_ims_inventory_v1.route("/v1/subscriptions") class SubscriptionsListRouter(Resource): model = SubscriptionDTO.subscription_get - expect = SubscriptionDTO.subscription - post_resp = SubscriptionDTO.subscription_post_resp + expect = SubscriptionDTO.subscription_create - @api_ims_inventory_v1.doc('List subscriptions') + @api_ims_inventory_v1.doc('Get Subscription List') @api_ims_inventory_v1.marshal_list_with(model) @api_ims_inventory_v1.param( PAGE_PARAM, @@ -491,23 +520,29 @@ class SubscriptionsListRouter(Resource): ret = ocloud_view.subscriptions(bus.uow, **kwargs) return link_header(request.full_path, ret) - @api_ims_inventory_v1.doc('Create a subscription') + @api_ims_inventory_v1.doc('Create a Subscription') @api_ims_inventory_v1.expect(expect) - @api_ims_inventory_v1.marshal_with(post_resp, code=201) + @api_ims_inventory_v1.marshal_with( + model, code=201, + mask='{subscriptionId,callback,consumerSubscriptionId,filter}') def post(self): data = api_ims_inventory_v1.payload + callback = data.get('callback', None) + if not callback: + raise BadRequestException('The callback parameter is required') + result = ocloud_view.subscription_create(data, bus.uow) return result, 201 -@api_ims_inventory_v1.route("/subscriptions/") +@api_ims_inventory_v1.route("/v1/subscriptions/") @api_ims_inventory_v1.param('subscriptionID', 'ID of the subscription') @api_ims_inventory_v1.response(404, 'Subscription not found') class SubscriptionGetDelRouter(Resource): model = SubscriptionDTO.subscription_get - @api_ims_inventory_v1.doc('Get subscription by ID') + @api_ims_inventory_v1.doc('Get Subscription Information') @api_ims_inventory_v1.marshal_with(model) @api_ims_inventory_v1.param( 'all_fields', @@ -535,11 +570,11 @@ class SubscriptionGetDelRouter(Resource): subscriptionID, bus.uow) if result is not None: return result - api_ims_inventory_v1.abort(404, "Subscription {} doesn't exist".format( + raise NotFoundException("Subscription {} doesn't exist".format( subscriptionID)) - @api_ims_inventory_v1.doc('Delete subscription by ID') - @api_ims_inventory_v1.response(204, 'Subscription deleted') + @api_ims_inventory_v1.doc('Delete a Subscription') + @api_ims_inventory_v1.response(200, 'Subscription deleted') def delete(self, subscriptionID): result = ocloud_view.subscription_delete(subscriptionID, bus.uow) - return result, 204 + return result, 200