X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=o2ims%2Fviews%2Focloud_route.py;h=434a431da8cb3286a5d85164a2ceea64633a8039;hb=0e743715cabed900807aa0ba9ade459006472274;hp=00fe520c1dad08e8d20e7dfa6657f700fb3c9b3b;hpb=91c02b447f2035ffbb11891ece162242c8f5a44f;p=pti%2Fo2.git diff --git a/o2ims/views/ocloud_route.py b/o2ims/views/ocloud_route.py index 00fe520..434a431 100644 --- a/o2ims/views/ocloud_route.py +++ b/o2ims/views/ocloud_route.py @@ -12,12 +12,16 @@ # See the License for the specific language governing permissions and # limitations under the License. -from flask_restx import Resource -from flask_restx import reqparse +from flask import request +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 @@ -31,9 +35,43 @@ def configure_api_route(): bus = MessageBus.get_instance() +# ---------- API versions ---------- # +@api_ims_inventory_v1.route("/v1/api_versions") +class VersionRouter(Resource): + 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', + 'Set any value for show all fields. This value will cover "fields" ' + + 'and "all_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'fields', + 'Set fields to show, split by comma, "/" for parent and children.' + + ' Like "name,parent/children". This value will cover "exculde_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_fields', + 'Set fields to exclude showing, split by comma, "/" for parent and ' + + 'children. Like "name,parent/children". This value will cover ' + + '"exclude_default".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_default', + 'Exclude showing all default fields, Set "true" to enable.', + _in='query') class OcloudsListRouter(Resource): """Ocloud get endpoint O2 interface ocloud endpoint @@ -46,24 +84,81 @@ class OcloudsListRouter(Resource): 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', + _in='query', default=1) +@api_ims_inventory_v1.param( + 'all_fields', + 'Set any value for show all fields. This value will cover "fields" ' + + 'and "all_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'fields', + 'Set fields to show, split by comma, "/" for parent and children.' + + ' Like "name,parent/children". This value will cover "exculde_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_fields', + 'Set fields to exclude showing, split by comma, "/" for parent and ' + + 'children. Like "name,parent/children". This value will cover ' + + '"exclude_default".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_default', + 'Exclude showing all default fields, Set "true" to enable.', + _in='query') +@api_ims_inventory_v1.param( + 'filter', + 'Filter of the query.', + _in='query') class ResourceTypesListRouter(Resource): model = ResourceTypeDTO.resource_type_get @api_ims_inventory_v1.marshal_list_with(model) def get(self): - return ocloud_view.resource_types(bus.uow) + parser = reqparse.RequestParser() + parser.add_argument(PAGE_PARAM, location='args') + parser.add_argument('filter', location='args') + args = parser.parse_args() + kwargs = {} + 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.resource_types(bus.uow, **kwargs) + 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( + 'all_fields', + 'Set any value for show all fields. This value will cover "fields" ' + + 'and "all_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'fields', + 'Set fields to show, split by comma, "/" for parent and children.' + + ' Like "name,parent/children". This value will cover "exculde_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_fields', + 'Set fields to exclude showing, split by comma, "/" for parent and ' + + 'children. Like "name,parent/children". This value will cover ' + + '"exclude_default".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_default', + 'Exclude showing all default fields, Set "true" to enable.', + _in='query') class ResourceTypeGetRouter(Resource): model = ResourceTypeDTO.resource_type_get @@ -74,24 +169,82 @@ class ResourceTypeGetRouter(Resource): 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)) + raise NotFoundException("Resource type {} doesn't exist".format( + resourceTypeID)) # ---------- 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', + _in='query', default=1) +@api_ims_inventory_v1.param( + 'all_fields', + 'Set any value for show all fields. This value will cover "fields" ' + + 'and "all_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'fields', + 'Set fields to show, split by comma, "/" for parent and children.' + + ' Like "name,parent/children". This value will cover "exculde_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_fields', + 'Set fields to exclude showing, split by comma, "/" for parent and ' + + 'children. Like "name,parent/children". This value will cover ' + + '"exclude_default".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_default', + 'Exclude showing all default fields, Set "true" to enable.', + _in='query') +@api_ims_inventory_v1.param( + 'filter', + 'Filter of the query.', + _in='query') class ResourcePoolsListRouter(Resource): model = ResourcePoolDTO.resource_pool_get @api_ims_inventory_v1.marshal_list_with(model) def get(self): - return ocloud_view.resource_pools(bus.uow) + parser = reqparse.RequestParser() + parser.add_argument(PAGE_PARAM, location='args') + parser.add_argument('filter', location='args') + args = parser.parse_args() + kwargs = {} + 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.resource_pools(bus.uow, **kwargs) + 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( + 'all_fields', + 'Set any value for show all fields. This value will cover "fields" ' + + 'and "all_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'fields', + 'Set fields to show, split by comma, "/" for parent and children.' + + ' Like "name,parent/children". This value will cover "exculde_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_fields', + 'Set fields to exclude showing, split by comma, "/" for parent and ' + + 'children. Like "name,parent/children". This value will cover ' + + '"exclude_default".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_default', + 'Exclude showing all default fields, Set "true" to enable.', + _in='query') class ResourcePoolGetRouter(Resource): model = ResourcePoolDTO.resource_pool_get @@ -102,17 +255,46 @@ class ResourcePoolGetRouter(Resource): 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.param('resourceTypeName', 'filter resource type', - location='args') -@api_ims_inventory_v1.param('parentId', 'filter parentId', - location='args') +# @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 ' + +# '(max 100). Default: 30', +# _in='query', default=30) +@api_ims_inventory_v1.param(PAGE_PARAM, + 'Page number of the results to fetch.' + + ' Default: 1', + _in='query', default=1) +@api_ims_inventory_v1.param( + 'all_fields', + 'Set any value for show all fields. This value will cover "fields" ' + + 'and "all_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'fields', + 'Set fields to show, split by comma, "/" for parent and children.' + + ' Like "name,parent/children". This value will cover "exculde_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_fields', + 'Set fields to exclude showing, split by comma, "/" for parent and ' + + 'children. Like "name,parent/children". This value will cover ' + + '"exclude_default".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_default', + 'Exclude showing all default fields, Set "true" to enable.', + _in='query') +@api_ims_inventory_v1.param( + 'filter', + 'Filter of the query.', + _in='query') class ResourcesListRouter(Resource): model = ResourceDTO.resource_list @@ -120,22 +302,46 @@ class ResourcesListRouter(Resource): @api_ims_inventory_v1.marshal_list_with(model) def get(self, resourcePoolID): parser = reqparse.RequestParser() - parser.add_argument('resourceTypeName', location='args') - parser.add_argument('parentId', location='args') + parser.add_argument(PAGE_PARAM, location='args') + parser.add_argument('filter', location='args') args = parser.parse_args() kwargs = {} - if args.resourceTypeName is not None: - kwargs['resourceTypeName'] = args.resourceTypeName - if args.parentId is not None: - kwargs['parentId'] = args.parentId - return ocloud_view.resources(resourcePoolID, bus.uow, **kwargs) + # if args.per_page is not None: + # kwargs['per_page'] = args.per_page + # base_url = base_url + 'per_page=' + args.per_page + '&' + 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) + 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') +@api_ims_inventory_v1.param( + 'all_fields', + 'Set any value for show all fields. This value will cover "fields" ' + + 'and "all_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'fields', + 'Set fields to show, split by comma, "/" for parent and children.' + + ' Like "name,parent/children". This value will cover "exculde_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_fields', + 'Set fields to exclude showing, split by comma, "/" for parent and ' + + 'children. Like "name,parent/children". This value will cover ' + + '"exclude_default".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_default', + 'Exclude showing all default fields, Set "true" to enable.', + _in='query') class ResourceGetRouter(Resource): # dto = ResourceDTO() @@ -148,25 +354,86 @@ class ResourceGetRouter(Resource): 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)) + raise NotFoundException("Resource {} doesn't exist".format( + resourceID)) # ---------- 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', + _in='query', default=1) +@api_ims_inventory_v1.param( + 'all_fields', + 'Set any value for show all fields. This value will cover "fields" ' + + 'and "all_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'fields', + 'Set fields to show, split by comma, "/" for parent and children.' + + ' Like "name,parent/children". This value will cover "exculde_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_fields', + 'Set fields to exclude showing, split by comma, "/" for parent and ' + + 'children. Like "name,parent/children". This value will cover ' + + '"exclude_default".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_default', + 'Exclude showing all default fields, Set "true" to enable.', + _in='query') +@api_ims_inventory_v1.param( + 'filter', + 'Filter of the query.', + _in='query') class DeploymentManagersListRouter(Resource): - model = DeploymentManagerDTO.deployment_manager_get + model = DeploymentManagerDTO.deployment_manager_list @api_ims_inventory_v1.marshal_list_with(model) def get(self): - return ocloud_view.deployment_managers(bus.uow) + parser = reqparse.RequestParser() + parser.add_argument(PAGE_PARAM, location='args') + parser.add_argument('filter', location='args') + args = parser.parse_args() + kwargs = {} + 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.deployment_managers(bus.uow, **kwargs) + 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 "native_k8sapi"', + _in='query') @api_ims_inventory_v1.response(404, 'Deployment manager not found') +@api_ims_inventory_v1.param( + 'all_fields', + 'Set any value for show all fields. This value will cover "fields" ' + + 'and "all_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'fields', + 'Set fields to show, split by comma, "/" for parent and children.' + + ' Like "name,parent/children". This value will cover "exculde_fields".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_fields', + 'Set fields to exclude showing, split by comma, "/" for parent and ' + + 'children. Like "name,parent/children". This value will cover ' + + '"exclude_default".', + _in='query') +@api_ims_inventory_v1.param( + 'exclude_default', + 'Exclude showing all default fields, Set "true" to enable.', + _in='query') class DeploymentManagerGetRouter(Resource): model = DeploymentManagerDTO.deployment_manager_get @@ -174,38 +441,91 @@ class DeploymentManagerGetRouter(Resource): @api_ims_inventory_v1.doc('Get deployment manager') @api_ims_inventory_v1.marshal_with(model) def get(self, deploymentManagerID): + parser = reqparse.RequestParser() + parser.add_argument('profile', location='args') + args = parser.parse_args() + profile = ( + args.profile if args.profile is not None and args.profile != '' + else ocloud.DeploymentManagerProfileDefault) result = ocloud_view.deployment_manager_one( - deploymentManagerID, bus.uow) - if result is not None: + deploymentManagerID, bus.uow, profile) + 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.marshal_list_with(model) + @api_ims_inventory_v1.param( + PAGE_PARAM, + 'Page number of the results to fetch. Default: 1', + _in='query', default=1) + @api_ims_inventory_v1.param( + 'all_fields', + 'Set any value for show all fields. This value will cover "fields" ' + + 'and "all_fields".', + _in='query') + @api_ims_inventory_v1.param( + 'fields', + 'Set fields to show, split by comma, "/" for parent and children.' + + ' Like "name,parent/children". This value will cover' + + ' "exculde_fields".', + _in='query') + @api_ims_inventory_v1.param( + 'exclude_fields', + 'Set fields to exclude showing, split by comma, "/" for parent and ' + + 'children. Like "name,parent/children". This value will cover ' + + '"exclude_default".', + _in='query') + @api_ims_inventory_v1.param( + 'exclude_default', + 'Exclude showing all default fields, Set "true" to enable.', + _in='query') + @api_ims_inventory_v1.param( + 'filter', + 'Filter of the query.', + _in='query') def get(self): - return ocloud_view.subscriptions(bus.uow) + parser = reqparse.RequestParser() + parser.add_argument(PAGE_PARAM, location='args') + parser.add_argument('filter', location='args') + args = parser.parse_args() + kwargs = {} + 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.subscriptions(bus.uow, **kwargs) + return link_header(request.full_path, ret) @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): @@ -214,16 +534,37 @@ class SubscriptionGetDelRouter(Resource): @api_ims_inventory_v1.doc('Get subscription by ID') @api_ims_inventory_v1.marshal_with(model) + @api_ims_inventory_v1.param( + 'all_fields', + 'Set any value for show all fields. This value will cover "fields" ' + + 'and "all_fields".', + _in='query') + @api_ims_inventory_v1.param( + 'fields', + 'Set fields to show, split by comma, "/" for parent and children.' + + ' Like "name,parent/children". This value will cover' + + ' "exculde_fields".', + _in='query') + @api_ims_inventory_v1.param( + 'exclude_fields', + 'Set fields to exclude showing, split by comma, "/" for parent and ' + + 'children. Like "name,parent/children". This value will cover ' + + '"exclude_default".', + _in='query') + @api_ims_inventory_v1.param( + 'exclude_default', + 'Exclude showing all default fields, Set "true" to enable.', + _in='query') def get(self, subscriptionID): result = ocloud_view.subscription_one( 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.response(200, 'Subscription deleted') def delete(self, subscriptionID): result = ocloud_view.subscription_delete(subscriptionID, bus.uow) - return result, 204 + return result, 200