# See the License for the specific language governing permissions and
# limitations under the License.
-from flask import jsonify
-from flask_restx import Resource
-
-from o2ims import config
+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 as api_ims_inventory_v1
from o2ims.views.ocloud_dto import OcloudDTO, ResourceTypeDTO,\
ResourcePoolDTO, ResourceDTO, DeploymentManagerDTO, SubscriptionDTO
-apibase = config.get_o2ims_api_base()
-# api = Namespace("O2IMS", description='IMS')
+from o2common.helper import o2logging
+logger = o2logging.get_logger(__name__)
-# ---------- OClouds ---------- #
-api_ocloud = OcloudDTO.api
+def configure_api_route():
+ # Set global bus for resource
+ global bus
+ 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': ''
+ }]
+ }
-@api_ocloud.route("/")
+# ---------- OClouds ---------- #
+@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
"""
- ocloud_get = OcloudDTO.ocloud_list
+ ocloud_get = OcloudDTO.ocloud
- @api_ocloud.marshal_list_with(ocloud_get)
+ @api_ims_inventory_v1.marshal_with(ocloud_get)
def get(self):
- return ocloud_view.oclouds(uow)
+ res = ocloud_view.oclouds(bus.uow)
+ if len(res) > 0:
+ return res[0]
+ raise NotFoundException("oCloud doesn't exist")
# ---------- ResourceTypes ---------- #
-api_rt = ResourceTypeDTO.api
-
-
-@api_rt.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_rt.marshal_list_with(model)
+ @api_ims_inventory_v1.marshal_list_with(model)
def get(self):
- return ocloud_view.resource_types(uow)
-
- # @api.doc(response={405: 'Method Not Allowed'})
- # def post(self):
- # api.abort(405)
-
- # @api.doc(response={405: 'Method Not Allowed'})
- # def put(self):
- # api.abort(405)
-
- # @api.doc(response={405: 'Method Not Allowed'})
- # def patch(self):
- # api.abort(405)
-
- # @api.doc(response={405: 'Method Not Allowed'})
- # def delete(self):
- # api.abort(405)
-
-
-@api_rt.route("/resourceTypes/<resourceTypeID>")
-@api_rt.param('resourceTypeID', 'ID of the resource type')
-@api_rt.response(404, 'Resource type not found')
+ 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("/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(
+ '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
- @api_rt.doc('Get resource type')
- @api_rt.marshal_with(model)
+ @api_ims_inventory_v1.doc('Get resource type')
+ @api_ims_inventory_v1.marshal_with(model)
def get(self, resourceTypeID):
- result = ocloud_view.resource_type_one(resourceTypeID, uow)
+ result = ocloud_view.resource_type_one(resourceTypeID, bus.uow)
if result is not None:
return result
- api_rt.abort(
- 404, "Resource type {} doesn't exist".format(resourceTypeID))
+ raise NotFoundException("Resource type {} doesn't exist".format(
+ resourceTypeID))
# ---------- ResourcePools ---------- #
-api_rp = ResourcePoolDTO.api
-
-
-@api_rp.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_rp.marshal_list_with(model)
+ @api_ims_inventory_v1.marshal_list_with(model)
def get(self):
- return ocloud_view.resource_pools(uow)
-
-
-@api_rp.route("/resourcePools/<resourcePoolID>")
-@api_rp.param('resourcePoolID', 'ID of the resource pool')
-@api_rp.response(404, 'Resource pool not found')
+ 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("/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(
+ '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
- @api_rp.doc('Get resource pool')
+ @api_ims_inventory_v1.doc('Get resource pool')
+ @api_ims_inventory_v1.marshal_with(model)
def get(self, resourcePoolID):
- result = ocloud_view.resource_pool_one(resourcePoolID, uow)
+ result = ocloud_view.resource_pool_one(resourcePoolID, bus.uow)
if result is not None:
return result
- api_rp.abort(
- 404, "Resource pool {} doesn't exist".format(resourcePoolID))
+ raise NotFoundException("Resource pool {} doesn't exist".format(
+ resourcePoolID))
# ---------- Resources ---------- #
-api_res = ResourceDTO.api
-
-
-@api_res.route("/resourcePools/<resourcePoolID>/resources")
-@api_res.param('resourcePoolID', 'ID of the resource pool')
+@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('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
- @api_res.marshal_list_with(model)
+ @api_ims_inventory_v1.marshal_list_with(model)
def get(self, resourcePoolID):
- return ocloud_view.resources(resourcePoolID, uow)
-
-
-@api_res.route("/resourcePools/<resourcePoolID>/resources/<resourceID>")
-@api_res.param('resourcePoolID', 'ID of the resource pool')
-@api_res.param('resourceID', 'ID of the resource')
-@api_res.response(404, 'Resource not found')
+ parser = reqparse.RequestParser()
+ parser.add_argument(PAGE_PARAM, location='args')
+ parser.add_argument('filter', location='args')
+ args = parser.parse_args()
+ 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(
+ "/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')
+@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):
- model = ResourceDTO.resource_get
+ # dto = ResourceDTO()
+ # model = dto.get_resource_get()
+ model = ResourceDTO.recursive_resource_mapping()
- @api_res.doc('Get resource')
+ @api_ims_inventory_v1.doc('Get resource')
+ @api_ims_inventory_v1.marshal_with(model)
def get(self, resourcePoolID, resourceID):
- result = ocloud_view.resource_one(resourceID, uow)
+ result = ocloud_view.resource_one(resourceID, bus.uow)
if result is not None:
return result
- api_res.abort(404, "Resource {} doesn't exist".format(resourceID))
+ raise NotFoundException("Resource {} doesn't exist".format(
+ resourceID))
# ---------- DeploymentManagers ---------- #
-api_dm = DeploymentManagerDTO.api
-
-
-@api_dm.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_dm.marshal_list_with(model)
+ @api_ims_inventory_v1.marshal_list_with(model)
def get(self):
- return ocloud_view.deployment_managers(uow)
-
-
-@api_dm.route("/deploymentManagers/<deploymentManagerID>")
-@api_dm.param('deploymentManagerID', 'ID of the deployment manager')
-@api_dm.response(404, 'Deployment manager not found')
+ 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("/v1/deploymentManagers/<deploymentManagerID>")
+@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
- @api_dm.doc('Get deployment manager')
+ @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, uow)
- if result is not None:
+ deploymentManagerID, bus.uow, profile)
+ if result is not None and result != "":
return result
- api_dm.abort(404, "Deployment manager {} doesn't exist".format(
+ elif result == "":
+ raise NotFoundException(
+ "Profile {} doesn't support".format(
+ args.profile))
+
+ raise NotFoundException("Deployment manager {} doesn't exist".format(
deploymentManagerID))
# ---------- Subscriptions ---------- #
-api_sub = SubscriptionDTO.api
-
-
-@api_sub.route("/subscriptions")
+@api_ims_inventory_v1.route("/v1/subscriptions")
class SubscriptionsListRouter(Resource):
model = SubscriptionDTO.subscription_get
-
- @api_sub.marshal_list_with(model)
+ 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(uow)
-
-
-@api_sub.route("/subscriptions/<subscriptionID>")
-@api_sub.param('subscriptionID', 'ID of the subscription')
-@api_sub.response(404, 'Subscription not found')
-class SubscriptionGetRouter(Resource):
+ 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(
+ 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("/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):
- model = DeploymentManagerDTO.deployment_manager_get
+ model = SubscriptionDTO.subscription_get
- @api_sub.doc('Get subscription by ID')
+ @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, uow)
+ subscriptionID, bus.uow)
if result is not None:
return result
- api_sub.abort(404, "Subscription {} doesn't exist".format(
+ raise NotFoundException("Subscription {} doesn't exist".format(
subscriptionID))
-
-def configure_namespace(app, bus):
-
- app.add_namespace(api_ocloud, path=apibase)
- app.add_namespace(api_rt, path=apibase)
- app.add_namespace(api_rp, path=apibase)
- app.add_namespace(api_res, path=apibase)
- app.add_namespace(api_dm, path=apibase)
- app.add_namespace(api_sub, path=apibase)
-
- # Set global uow
- global uow
- uow = bus.uow
-
-
-def configure_routes(app, bus):
-
- # ---------- OClouds ---------- #
- @app.route(apibase, methods=["GET"])
- def oclouds():
- result = ocloud_view.oclouds(bus.uow)
- return jsonify(result), 200
-
- # ---------- ResourceTypes ---------- #
-
- @app.route(apibase + "/resourceTypes", methods=["GET"])
- def resource_types():
- result = ocloud_view.resource_types(bus.uow)
- return jsonify(result), 200
-
- @app.route(apibase + "/resourceTypes", methods=["POST", "PUT", "PATCH",
- "DELETE"])
- def resource_types_not_allow():
- return "Method Not Allowed", 405
-
- @app.route(apibase + "/resourceTypes/<resourceTypeID>", methods=["GET"])
- def resource_types_one(resourceTypeID):
- result = ocloud_view.resource_type_one(resourceTypeID, bus.uow)
- if result is None:
- return "", 200
- return jsonify(result), 200
-
- @app.route(apibase + "/resourceTypes/<resourceTypeID>",
- methods=["POST", "PUT", "PATCH", "DELETE"])
- def resource_types_one_not_allow(resourceTypeID):
- return "Method Not Allowed", 405
-
- # ---------- ResourcePools ---------- #
-
- @app.route(apibase + "/resourcePools", methods=["GET"])
- def resource_pools():
- result = ocloud_view.resource_pools(bus.uow)
- return jsonify(result), 200
-
- @app.route(apibase + "/resourcePools", methods=["POST", "PUT", "PATCH",
- "DELETE"])
- def resource_pools_not_allow():
- return "Method Not Allowed", 405
-
- @app.route(apibase + "/resourcePools/<resourcePoolID>", methods=["GET"])
- def resource_pools_one(resourcePoolID):
- result = ocloud_view.resource_pool_one(resourcePoolID, bus.uow)
- if result is None:
- return "", 200
- return jsonify(result), 200
-
- @app.route(apibase + "/resourcePools/<resourcePoolID>",
- methods=["POST", "PUT", "PATCH", "DELETE"])
- def resource_pools_one_not_allow(resourcePoolID):
- return "Method Not Allowed", 405
-
- # ---------- Resources ---------- #
-
- @app.route(apibase + "/resourcePools/<resourcePoolID>/resources",
- methods=["GET"])
- def resources(resourcePoolID):
- result = ocloud_view.resources(resourcePoolID, bus.uow)
- return jsonify(result), 200
-
- @app.route(apibase + "/resourcePools/<resourcePoolID>/resources",
- methods=["POST", "PUT", "PATCH", "DELETE"])
- def resource_not_allow(resourcePoolID):
- return "Method Not Allowed", 405
-
- @app.route(apibase +
- "/resourcePools/<resourcePoolID>/resources/<resourceID>",
- methods=["GET"])
- def resources_one(resourcePoolID, resourceID):
- result = ocloud_view.resource_one(resourceID, bus.uow)
- if result is None:
- return "", 200
- return jsonify(result), 200
-
- @app.route(apibase +
- "/resourcePools/<resourcePoolID>/resources/<resourceID>",
- methods=["POST", "PUT", "PATCH", "DELETE"])
- def resource_one_not_allow(resourcePoolID, resourceID):
- return "Method Not Allowed", 405
-
- # ---------- DeploymentManagers ---------- #
-
- @app.route(apibase + "/deploymentManagers", methods=["GET"])
- def deployment_managers():
- result = ocloud_view.deployment_managers(bus.uow)
- return jsonify(result), 200
-
- @app.route(apibase + "/deploymentManagers",
- methods=["POST", "PUT", "PATCH", "DELETE"])
- def deployment_managers_not_allow():
- return "Method Not Allowed", 405
-
- @app.route(apibase + "/deploymentManagers/<deploymentManagerID>",
- methods=["GET"])
- def deployment_manager_one(deploymentManagerID):
- result = ocloud_view.deployment_manager_one(
- deploymentManagerID, bus.uow)
- if result is None:
- return "", 200
- return jsonify(result), 200
-
- @app.route(apibase + "/deploymentManagers/<deploymentManagerID>",
- methods=["POST", "PUT", "PATCH", "DELETE"])
- def deployment_manager_one_not_allow(deploymentManagerID):
- return "Method Not Allowed", 405
+ @api_ims_inventory_v1.doc('Delete subscription by ID')
+ @api_ims_inventory_v1.response(200, 'Subscription deleted')
+ def delete(self, subscriptionID):
+ result = ocloud_view.subscription_delete(subscriptionID, bus.uow)
+ return result, 200