# See the License for the specific language governing permissions and
# limitations under the License.
-from flask_restx import Resource
+from flask import request
+from flask_restx import Resource, reqparse
-from o2ims.views import ocloud_view, api_ims_inventory_v1
-from o2common.config import config
+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,\
- ResourcePoolDTO, ResourceDTO, DeploymentManagerDTO, SubscriptionDTO,\
- RegistrationDTO
+ ResourcePoolDTO, ResourceDTO, DeploymentManagerDTO, SubscriptionDTO
+from o2common.helper import o2logging
+logger = o2logging.get_logger(__name__)
-apibase = config.get_o2ims_api_base()
+
+def configure_api_route():
+ # Set global bus for resource
+ global bus
+ bus = MessageBus.get_instance()
# ---------- OClouds ---------- #
# ---------- 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)
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/<resourceTypeID>")
# ---------- 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)
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/<resourcePoolID>")
# ---------- Resources ---------- #
@api_ims_inventory_v1.route("/resourcePools/<resourcePoolID>/resources")
@api_ims_inventory_v1.param('resourcePoolID', 'ID of the resource pool')
+@api_ims_inventory_v1.param('resourceTypeName', 'filter resource type',
+ _in='query')
+@api_ims_inventory_v1.param('parentId', 'filter parentId',
+ _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)
class ResourcesListRouter(Resource):
model = ResourceDTO.resource_list
@api_ims_inventory_v1.marshal_list_with(model)
def get(self, resourcePoolID):
- return ocloud_view.resources(resourcePoolID, bus.uow)
+ parser = reqparse.RequestParser()
+ parser.add_argument('resourceTypeName', location='args')
+ parser.add_argument('parentId', location='args')
+ # parser.add_argument('sort', location='args')
+ # parser.add_argument('per_page', location='args')
+ parser.add_argument(PAGE_PARAM, 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
+ 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
+
+ ret = ocloud_view.resources(resourcePoolID, bus.uow, **kwargs)
+
+ return link_header(request.full_path, ret)
@api_ims_inventory_v1.route(
# ---------- 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)
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')
+ 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/<deploymentManagerID>")
@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.response(404, 'Deployment manager not found')
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 'default')
result = ocloud_view.deployment_manager_one(
- deploymentManagerID, bus.uow)
+ deploymentManagerID, bus.uow, profile)
if result is not None:
return result
api_ims_inventory_v1.abort(
@api_ims_inventory_v1.doc('List subscriptions')
@api_ims_inventory_v1.marshal_list_with(model)
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)
def delete(self, subscriptionID):
result = ocloud_view.subscription_delete(subscriptionID, bus.uow)
return result, 204
-
-
-# ---------- Registration ---------- #
-@api_ims_inventory_v1.route("/registrations")
-class RegistrationListRouter(Resource):
-
- model = RegistrationDTO.registration_get
- expect = RegistrationDTO.registration
- post_resp = RegistrationDTO.registration_post_resp
-
- @api_ims_inventory_v1.doc('List registrations')
- @api_ims_inventory_v1.marshal_list_with(model)
- def get(self):
- return ocloud_view.registrations(bus.uow)
-
- @api_ims_inventory_v1.doc('Create a registration')
- @api_ims_inventory_v1.expect(expect)
- @api_ims_inventory_v1.marshal_with(post_resp, code=201)
- def post(self):
- data = api_ims_inventory_v1.payload
- result = ocloud_view.registration_create(data, bus.uow)
- return result, 201
-
-
-@api_ims_inventory_v1.route("/registrations/<registrationID>")
-@api_ims_inventory_v1.param('registrationID', 'ID of the registration')
-@api_ims_inventory_v1.response(404, 'Registration not found')
-class RegistrationGetDelRouter(Resource):
-
- model = RegistrationDTO.registration_get
-
- @api_ims_inventory_v1.doc('Get registration by ID')
- @api_ims_inventory_v1.marshal_with(model)
- def get(self, registrationID):
- result = ocloud_view.registration_one(
- registrationID, bus.uow)
- if result is not None:
- return result
- api_ims_inventory_v1.abort(404, "Registration {} doesn't exist".format(
- registrationID))
-
- @api_ims_inventory_v1.doc('Delete registration by ID')
- @api_ims_inventory_v1.response(204, 'Registration deleted')
- def delete(self, registrationID):
- result = ocloud_view.registration_delete(registrationID, bus.uow)
- return result, 204
-
-
-def configure_namespace(app, bus_new):
-
- # Set global bus for resource
- global bus
- bus = bus_new
-
- app.add_namespace(api_ims_inventory_v1, path=apibase)