from o2common.service.messagebus import MessageBus
from o2common.views.pagination_route import link_header, PAGE_PARAM
+from o2common.views.route_exception import NotFoundException
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
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/")
@api_ims_inventory_v1.response(404, 'oCloud not found')
@api_ims_inventory_v1.param(
'all_fields',
_in='query')
@api_ims_inventory_v1.param(
'fields',
- 'Set fields to show, split by comman, "/" for parent and children.' +
+ '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 comman, "/" for parent and ' +
+ 'Set fields to exclude showing, split by comma, "/" for parent and ' +
'children. Like "name,parent/children". This value will cover ' +
'"exclude_default".',
_in='query')
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')
@api_ims_inventory_v1.param(
'fields',
- 'Set fields to show, split by comman, "/" for parent and children.' +
+ '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 comman, "/" for parent and ' +
+ 'Set fields to exclude showing, split by comma, "/" for parent and ' +
'children. Like "name,parent/children". This value will cover ' +
'"exclude_default".',
_in='query')
'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
def get(self):
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/<resourceTypeID>")
+@api_ims_inventory_v1.route("/v1/resourceTypes/<resourceTypeID>")
@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(
_in='query')
@api_ims_inventory_v1.param(
'fields',
- 'Set fields to show, split by comman, "/" for parent and children.' +
+ '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 comman, "/" for parent and ' +
+ 'Set fields to exclude showing, split by comma, "/" for parent and ' +
'children. Like "name,parent/children". This value will cover ' +
'"exclude_default".',
_in='query')
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')
@api_ims_inventory_v1.param(
'fields',
- 'Set fields to show, split by comman, "/" for parent and children.' +
+ '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 comman, "/" for parent and ' +
+ 'Set fields to exclude showing, split by comma, "/" for parent and ' +
'children. Like "name,parent/children". This value will cover ' +
'"exclude_default".',
_in='query')
'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
def get(self):
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/<resourcePoolID>")
+@api_ims_inventory_v1.route("/v1/resourcePools/<resourcePoolID>")
@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(
_in='query')
@api_ims_inventory_v1.param(
'fields',
- 'Set fields to show, split by comman, "/" for parent and children.' +
+ '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 comman, "/" for parent and ' +
+ 'Set fields to exclude showing, split by comma, "/" for parent and ' +
'children. Like "name,parent/children". This value will cover ' +
'"exclude_default".',
_in='query')
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/<resourcePoolID>/resources")
+@api_ims_inventory_v1.route("/v1/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 ' +
_in='query')
@api_ims_inventory_v1.param(
'fields',
- 'Set fields to show, split by comman, "/" for parent and children.' +
+ '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 comman, "/" for parent and ' +
+ 'Set fields to exclude showing, split by comma, "/" for parent and ' +
'children. Like "name,parent/children". This value will cover ' +
'"exclude_default".',
_in='query')
'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
@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
- 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
+ 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/<resourcePoolID>/resources/<resourceID>")
+ "/v1/resourcePools/<resourcePoolID>/resources/<resourceID>")
@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')
_in='query')
@api_ims_inventory_v1.param(
'fields',
- 'Set fields to show, split by comman, "/" for parent and children.' +
+ '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 comman, "/" for parent and ' +
+ 'Set fields to exclude showing, split by comma, "/" for parent and ' +
'children. Like "name,parent/children". This value will cover ' +
'"exclude_default".',
_in='query')
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')
@api_ims_inventory_v1.param(
'fields',
- 'Set fields to show, split by comman, "/" for parent and children.' +
+ '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 comman, "/" for parent and ' +
+ 'Set fields to exclude showing, split by comma, "/" for parent and ' +
'children. Like "name,parent/children". This value will cover ' +
'"exclude_default".',
_in='query')
'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_list
def get(self):
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/<deploymentManagerID>")
+@api_ims_inventory_v1.route("/v1/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.param(
'fields',
- 'Set fields to show, split by comman, "/" for parent and children.' +
+ '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 comman, "/" for parent and ' +
+ 'Set fields to exclude showing, split by comma, "/" for parent and ' +
'children. Like "name,parent/children". This value will cover ' +
'"exclude_default".',
_in='query')
deploymentManagerID, bus.uow, profile)
if result is not None:
return result
- api_ims_inventory_v1.abort(
- 404,
- "Deployment manager {} doesn't exist".format(deploymentManagerID))
+ 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
_in='query')
@api_ims_inventory_v1.param(
'fields',
- 'Set fields to show, split by comman, "/" for parent and children.' +
+ '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 comman, "/" for parent and ' +
+ 'Set fields to exclude showing, split by comma, "/" for parent and ' +
'children. Like "name,parent/children". This value will cover ' +
'"exclude_default".',
_in='query')
'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):
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)
return result, 201
-@api_ims_inventory_v1.route("/subscriptions/<subscriptionID>")
+@api_ims_inventory_v1.route("/v1/subscriptions/<subscriptionID>")
@api_ims_inventory_v1.param('subscriptionID', 'ID of the subscription')
@api_ims_inventory_v1.response(404, 'Subscription not found')
class SubscriptionGetDelRouter(Resource):
_in='query')
@api_ims_inventory_v1.param(
'fields',
- 'Set fields to show, split by comman, "/" for parent and children.' +
+ '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 comman, "/" for parent and ' +
+ 'Set fields to exclude showing, split by comma, "/" for parent and ' +
'children. Like "name,parent/children". This value will cover ' +
'"exclude_default".',
_in='query')
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
Code Review / pti / o2.git / blobdiff