Fix api_versions request failed issue, Add oCloudId in the DMS query

[pti/o2.git] / o2ims / views / ocloud_route.py

diff --git a/o2ims/views/ocloud_route.py b/o2ims/views/ocloud_route.py
index 43a4761..2490d4a 100644 (file)
--- a/o2ims/views/ocloud_route.py
+++ b/o2ims/views/ocloud_route.py
@@ -18,7 +18,7 @@ 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.api_ns import api_ims_inventory as api_ims_inventory_v1
 from o2ims.views.ocloud_dto import OcloudDTO, ResourceTypeDTO,\
     ResourcePoolDTO, ResourceDTO, DeploymentManagerDTO, SubscriptionDTO
 
@@ -32,8 +32,22 @@ def configure_api_route():
     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',
@@ -42,12 +56,12 @@ def configure_api_route():
     _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')
@@ -72,7 +86,7 @@ class OcloudsListRouter(Resource):
 
 
 # ----------  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',
@@ -84,12 +98,12 @@ class OcloudsListRouter(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')
@@ -97,6 +111,10 @@ class OcloudsListRouter(Resource):
     '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
@@ -105,16 +123,18 @@ class ResourceTypesListRouter(Resource):
     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(
@@ -124,12 +144,12 @@ class ResourceTypesListRouter(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')
@@ -152,7 +172,7 @@ class ResourceTypeGetRouter(Resource):
 
 
 # ----------  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',
@@ -164,12 +184,12 @@ class ResourceTypeGetRouter(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')
@@ -177,6 +197,10 @@ class ResourceTypeGetRouter(Resource):
     '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
@@ -185,16 +209,18 @@ class ResourcePoolsListRouter(Resource):
     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(
@@ -204,12 +230,12 @@ class ResourcePoolsListRouter(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')
@@ -232,12 +258,8 @@ class ResourcePoolGetRouter(Resource):
 
 
 # ----------  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 ' +
@@ -254,12 +276,12 @@ class ResourcePoolGetRouter(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')
@@ -267,6 +289,10 @@ class ResourcePoolGetRouter(Resource):
     '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
@@ -274,29 +300,23 @@ class ResourcesListRouter(Resource):
     @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')
@@ -307,12 +327,12 @@ class ResourcesListRouter(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')
@@ -337,7 +357,7 @@ class ResourceGetRouter(Resource):
 
 
 # ----------  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',
@@ -349,12 +369,12 @@ class ResourceGetRouter(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')
@@ -362,6 +382,10 @@ class ResourceGetRouter(Resource):
     '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
@@ -370,16 +394,18 @@ class DeploymentManagersListRouter(Resource):
     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"',
@@ -392,12 +418,12 @@ class DeploymentManagersListRouter(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')
@@ -428,7 +454,7 @@ class DeploymentManagerGetRouter(Resource):
 
 
 # ----------  Subscriptions ---------- #
-@api_ims_inventory_v1.route("/subscriptions")
+@api_ims_inventory_v1.route("/v1/subscriptions")
 class SubscriptionsListRouter(Resource):
 
     model = SubscriptionDTO.subscription_get
@@ -448,13 +474,13 @@ class SubscriptionsListRouter(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')
@@ -462,13 +488,19 @@ class SubscriptionsListRouter(Resource):
         '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)
@@ -482,7 +514,7 @@ class SubscriptionsListRouter(Resource):
         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):
@@ -498,13 +530,13 @@ 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')