CSCMETAX-395: [FIX] Datasets api /datasets/pid/files now also supports ?file_fields=x,y,z parameter

Author: Hannu Kamarainen

src/metax_api/api/rest/base/views/dataset_view.py

@@ -211,7 +211,14 @@ def files_get(self, request, pk=None):
             params['removed'] = True
             manager = 'objects_unfiltered'
 
-        files = [ FileSerializer(f).data for f in catalog_record.files(manager=manager).filter(**params) ]
+        file_fields = []
+        if 'file_fields' in request.query_params:
+            file_fields = request.query_params['file_fields'].split(',')
+
+        files = [
+            FileSerializer(f, only_fields=file_fields).data
+            for f in catalog_record.files(manager=manager).filter(**params).only(*file_fields)
+        ]
 
         return Response(data=files, status=status.HTTP_200_OK)
 

src/metax_api/tests/api/rest/base/views/datasets/read.py

@@ -519,14 +519,33 @@ def test_directory_details_populated(self):
         self.assertEqual(response.data['research_dataset']['directories'][1]['details']['file_count'], 20)
 
 
-class CatalogRecordApiReadRemovedFiles(CatalogRecordApiReadCommon):
+class CatalogRecordApiReadFiles(CatalogRecordApiReadCommon):
 
     """
-    Test use of query parameter removed_files=bool in /datasets/pid/files, which should return
-    only deleted files.
+    Test /datasets/pid/files api
     """
 
+    def test_get_files(self):
+        file_count = CatalogRecord.objects.get(pk=1).files.count()
+        response = self.client.get('/rest/datasets/1/files')
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(len(response.data), file_count)
+
+    def test_get_files_specified_fields_only(self):
+        """
+        Test use of query parameter ?file_fields=x,y,z
+        """
+        response = self.client.get('/rest/datasets/1/files?file_fields=identifier,file_path')
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(len(response.data[0].keys()), 2)
+        self.assertEqual('identifier' in response.data[0], True)
+        self.assertEqual('file_path' in response.data[0], True)
+
     def test_removed_query_param(self):
+        """
+        Test use of query parameter removed_files=bool in /datasets/pid/files, which should return
+        only deleted files.
+        """
         response = self.client.get('/rest/datasets/1/files')
         file_ids_before = set([ f['id'] for f in response.data ])
         obj = File.objects.get(pk=1)

swagger/swagger.yaml

@@ -1037,6 +1037,11 @@ paths:
           description: Persistent ID of dataset OR the internal pk
           required: true
           type: string
+        - name: file_fields
+          in: query
+          description: Comma-separated list of field names to retrieve for files
+          required: false
+          type: string
         - name: removed_files
           in: query
           description: return only deleted files