X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=o2ims%2Fviews%2Focloud_route.py;h=43a4761abff7e6a46d328f24a99a930ad667916b;hb=refs%2Fchanges%2F88%2F9388%2F1;hp=3490072406c3373466a7a20fbd7f46ec023119b6;hpb=513d34988f76825846a2379078eb4aedcaed9f27;p=pti%2Fo2.git diff --git a/o2ims/views/ocloud_route.py b/o2ims/views/ocloud_route.py index 3490072..43a4761 100644 --- a/o2ims/views/ocloud_route.py +++ b/o2ims/views/ocloud_route.py @@ -12,9 +12,11 @@ # See the License for the specific language governing permissions and # limitations under the License. +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 o2ims.views import ocloud_view from o2ims.views.api_ns import api_ims_inventory_v1 from o2ims.views.ocloud_dto import OcloudDTO, ResourceTypeDTO,\ @@ -33,6 +35,26 @@ def configure_api_route(): # ---------- OClouds ---------- # @api_ims_inventory_v1.route("/") @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 comman, "/" 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 comman, "/" 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 @@ -51,18 +73,70 @@ class OcloudsListRouter(Resource): # ---------- ResourceTypes ---------- # @api_ims_inventory_v1.route("/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 comman, "/" 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 comman, "/" 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 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') + args = parser.parse_args() + kwargs = {} + if args.nextpage_opaque_marker is not None: + kwargs['page'] = args.nextpage_opaque_marker + + 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.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 comman, "/" 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 comman, "/" 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 @@ -79,18 +153,70 @@ class ResourceTypeGetRouter(Resource): # ---------- ResourcePools ---------- # @api_ims_inventory_v1.route("/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 comman, "/" 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 comman, "/" 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 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') + args = parser.parse_args() + kwargs = {} + if args.nextpage_opaque_marker is not None: + kwargs['page'] = args.nextpage_opaque_marker + + 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.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 comman, "/" 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 comman, "/" 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 @@ -109,9 +235,38 @@ class ResourcePoolGetRouter(Resource): @api_ims_inventory_v1.route("/resourcePools//resources") @api_ims_inventory_v1.param('resourcePoolID', 'ID of the resource pool') @api_ims_inventory_v1.param('resourceTypeName', 'filter resource type', - location='args') + _in='query') @api_ims_inventory_v1.param('parentId', 'filter parentId', - location='args') + _in='query') +# @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 comman, "/" 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 comman, "/" 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 ResourcesListRouter(Resource): model = ResourceDTO.resource_list @@ -121,6 +276,7 @@ class ResourcesListRouter(Resource): parser = reqparse.RequestParser() parser.add_argument('resourceTypeName', location='args') parser.add_argument('parentId', location='args') + parser.add_argument(PAGE_PARAM, location='args') args = parser.parse_args() kwargs = {} if args.resourceTypeName is not None: @@ -129,8 +285,14 @@ class ResourcesListRouter(Resource): kwargs['parentId'] = args.parentId if args.parentId.lower() == 'null': kwargs['parentId'] = None + # 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 - return ocloud_view.resources(resourcePoolID, bus.uow, **kwargs) + ret = ocloud_view.resources(resourcePoolID, bus.uow, **kwargs) + return link_header(request.full_path, ret) @api_ims_inventory_v1.route( @@ -138,6 +300,26 @@ class ResourcesListRouter(Resource): @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 comman, "/" 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 comman, "/" 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() @@ -156,21 +338,73 @@ class ResourceGetRouter(Resource): # ---------- DeploymentManagers ---------- # @api_ims_inventory_v1.route("/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 comman, "/" 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 comman, "/" 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 DeploymentManagersListRouter(Resource): 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') + args = parser.parse_args() + kwargs = {} + if args.nextpage_opaque_marker is not None: + kwargs['page'] = args.nextpage_opaque_marker + + 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.param('deploymentManagerID', 'ID of the deployment manager') -@api_ims_inventory_v1.param('profile', 'DMS profile: value supports "sol0018"', +@api_ims_inventory_v1.param('profile', 'DMS profile: value supports "sol018"', _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 comman, "/" 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 comman, "/" 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 @@ -203,8 +437,41 @@ class SubscriptionsListRouter(Resource): @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 comman, "/" 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 comman, "/" 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): - return ocloud_view.subscriptions(bus.uow) + parser = reqparse.RequestParser() + parser.add_argument(PAGE_PARAM, location='args') + args = parser.parse_args() + kwargs = {} + if args.nextpage_opaque_marker is not None: + kwargs['page'] = args.nextpage_opaque_marker + + 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) @@ -224,6 +491,27 @@ 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 comman, "/" 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 comman, "/" 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)