[fix] Added CSV batch download endpoint to REST API docs #373

Closes #373

Author: stktyagi

docs/user/rest-api.rst

@@ -861,16 +861,13 @@ Batch CSV Download
 
 .. code-block:: text
 
-    /api/v1/radius/organization/<organization-slug>/batch/<id>/csv/<filename>
+    /api/v1/radius/organization/<organization-slug>/batch/<id>/csv/
 
-Responds only to **GET**.
+Responds only to **GET**. Allows downloading the CSV file used to import
+users for a specific batch user creation operation. Example:
 
-Parameters:
+.. code-block:: shell
 
-======== ===========
-Param    Description
-======== ===========
-slug     string
-id       string
-filename string
-======== ===========
+    curl -X GET \
+        'http://127.0.0.1:8000/api/v1/radius/organization/default/batch/f4943c8a-462e-40ba-89b6-91a2541c9cf4/csv/' \
+        -H 'Authorization: Bearer your-token-here'

openwisp_radius/private_storage/urls.py

@@ -8,6 +8,14 @@
 
 def get_private_store_urls():
     return [
+        path(
+            urljoin(
+                app_settings.CSV_URL_PATH,
+                "<slug:slug>/batch/<uuid:pk>/csv/",
+            ),
+            views.rad_batch_csv_download_api_view,
+            name="radius_organization_batch_csv_read",
+        ),
         path(
             # Use "path" URL kwarg to make it consistent with
             # django-private-storage. Otherwise, the S3 reverse
@@ -16,5 +24,5 @@ def get_private_store_urls():
             urljoin(app_settings.CSV_URL_PATH, "<path:path>"),
             views.rad_batch_csv_download_view,
             name="serve_private_file",
-        )
+        ),
     ]

openwisp_radius/private_storage/views.py

@@ -1,4 +1,8 @@
+from django.utils.translation import gettext_lazy as _
+from drf_yasg import openapi
+from drf_yasg.utils import swagger_auto_schema
 from private_storage.views import PrivateStorageDetailView
+from rest_framework.views import APIView
 
 from ..settings import PRIVATE_STORAGE_INSTANCE
 from ..utils import load_model
@@ -10,6 +14,7 @@ class RadiusBatchCsvDownloadView(PrivateStorageDetailView):
     model_file_field = "csvfile"
     slug_field = "csvfile"
     slug_url_kwarg = "path"
+    pk_url_kwarg = "pk"
 
     def can_access_file(self, private_file):
         user = private_file.request.user
@@ -19,3 +24,24 @@ def can_access_file(self, private_file):
 
 
 rad_batch_csv_download_view = RadiusBatchCsvDownloadView.as_view()
+
+
+class RadiusBatchCsvDownloadAPIView(APIView):
+    @swagger_auto_schema(
+        operation_id="radius_organization_batch_csv_read",
+        operation_description=_(
+            "Allows downloading the CSV file used to import users for a "
+            "specific batch user creation operation."
+        ),
+        responses={
+            200: openapi.Response(
+                description=_("CSV file"), schema=openapi.Schema(type=openapi.TYPE_FILE)
+            ),
+        },
+        tags=["radius"],
+    )
+    def get(self, request, _slug, pk, *args, **kwargs):
+        return rad_batch_csv_download_view(request, pk=pk, **kwargs)
+
+
+rad_batch_csv_download_api_view = RadiusBatchCsvDownloadAPIView.as_view()