from o2common.service.messagebus import MessageBus
from o2common.views.pagination_route import link_header, PAGE_PARAM
-from o2common.views.route import ProblemDetails
+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 as api_ims_inventory_v1
from o2ims.views.ocloud_dto import OcloudDTO, ResourceTypeDTO,\
# ---------- 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],
# ---------- OClouds ---------- #
-@api_ims_inventory_v1.route("/v1/")
+@api_ims_inventory_v1.route(*["/v1", "/v1/"])
@api_ims_inventory_v1.response(404, 'oCloud not found')
@api_ims_inventory_v1.param(
'all_fields',
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]
- ProblemDetails(
- api_ims_inventory_v1,
- 404, "oCloud doesn't exist").abort()
+ raise NotFoundException("oCloud doesn't exist")
# ---------- ResourceTypes ---------- #
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()
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
- ProblemDetails(
- api_ims_inventory_v1,
- 404, "Resource type {} doesn't exist".format(
- resourceTypeID)).abort()
+ if not result:
+ raise NotFoundException("Resource type {} doesn't exist".format(
+ resourceTypeID))
+ return result
# ---------- ResourcePools ---------- #
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()
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
- ProblemDetails(
- api_ims_inventory_v1,
- 404, "Resource pool {} doesn't exist".format(
- resourcePoolID)).abort()
+ raise NotFoundException("Resource pool {} doesn't exist".format(
+ 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.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 ' +
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()
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)
# 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
- ProblemDetails(
- api_ims_inventory_v1,
- 404, "Resource {} doesn't exist".format(
- resourceID)).abort()
+ result = ocloud_view.resource_one(resourceID, bus.uow, resourcePoolID)
+ if result is None:
+ raise NotFoundException("Resource {} doesn't exist".format(
+ resourceID))
+ return result
# ---------- DeploymentManagers ---------- #
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()
@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(
+ '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',
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()
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
+ elif result == "":
+ raise NotFoundException(
+ "Profile {} doesn't support".format(
+ args.profile))
- ProblemDetails(
- api_ims_inventory_v1,
- 404, "Deployment manager {} doesn't exist".format(
- deploymentManagerID)).abort()
+ raise NotFoundException("Deployment manager {} doesn't exist".format(
+ deploymentManagerID))
# ---------- 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,
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
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',
subscriptionID, bus.uow)
if result is not None:
return result
- ProblemDetails(
- api_ims_inventory_v1,
- 404, "Subscription {} doesn't exist".format(
- subscriptionID)).abort()
+ 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
Code Review / pti / o2.git / blobdiff