Add swagger response to tar_list method

Author: vinulw

src/server/oasisapi/analyses/v2_api/viewsets.py

@@ -33,6 +33,7 @@
     SUBTASK_STATUS_PARAM,
     SUBTASK_SLUG_PARAM,
     FILENAME_PARAM,
+    FILE_LIST_RESPONSE,
 )
 
 
@@ -422,7 +423,7 @@ def input_file(self, request, pk=None, version=None):
         return handle_related_file(self.get_object(), 'input_file', request, ['application/x-gzip', 'application/gzip', 'application/x-tar', 'application/tar'])
 
 
-    @swagger_auto_schema(methods=['get'])
+    @swagger_auto_schema(methods=['get'], responses={200: FILE_LIST_RESPONSE})
     @action(methods=['get'], detail=True)
     def input_file_tar_list(self, request, pk=None, version=None):
         """
@@ -526,7 +527,7 @@ def output_file(self, request, pk=None, version=None):
         """
         return handle_related_file(self.get_object(), 'output_file', request, ['application/x-gzip', 'application/gzip', 'application/x-tar', 'application/tar'])
 
-    @swagger_auto_schema(methods=['get'])
+    @swagger_auto_schema(methods=['get'], responses={200: FILE_LIST_RESPONSE})
     @action(methods=['get'], detail=True)
     def output_file_tar_list(self, request, pk=None, version=None):
         """

src/server/oasisapi/schemas/custom_swagger.py

@@ -1,5 +1,6 @@
 __all__ = [
     'FILE_RESPONSE',
+    'FILE_LIST_RESPONSE',
     'HEALTHCHECK',
     'TOKEN_REFRESH_HEADER',
     'FILE_FORMAT_PARAM',
@@ -29,6 +30,14 @@
 
     })
 
+
+FILE_LIST_RESPONSE = openapi.Response(
+    'File List',
+    schema = Schema(type=openapi.TYPE_ARRAY,
+                    items=Schema(title='File Name', type=openapi.TYPE_STRING))
+)
+
+
 HEALTHCHECK = Schema(
     title='HealthCheck',
     type='object',