update irodsinfo api versioning (#1936)

docs_manual/source/api_irodsinfo.rst

@@ -6,20 +6,22 @@ Irods Info API
 The REST API for the iRODS Info app is described in this document.
 
 
+Versioning
+==========
+
+Media Type
+    ``application/vnd.bihealth.sodar.irodsinfo+json``
+Current Version
+    ``1.0``
+Accepted Versions
+    ``1.0``
+Header Example
+    ``Accept: application/vnd.bihealth.sodar.irodsinfo+json; version=x.y``
+
+
 API Views
 =========
 
 .. currentmodule:: irodsinfo.views_api
 
 .. autoclass:: IrodsEnvRetrieveAPIView
-
-
-Versioning
-==========
-
-For accept header versioning, the following header is expected in the current
-SODAR version:
-
-.. code-block:: console
-
-    Accept: application/vnd.bihealth.sodar+json; version=0.15.0

irodsinfo/tests/test_permissions_api.py

@@ -4,15 +4,26 @@
 
 # Projectroles dependency
 from projectroles.tests.test_permissions import SiteAppPermissionTestBase
+from projectroles.tests.test_permissions_api import SODARAPIPermissionTestMixin
 
+from irodsinfo.views_api import (
+    IRODSINFO_API_MEDIA_TYPE,
+    IRODSINFO_API_DEFAULT_VERSION,
+)
 
-class TestIrodsConfigRetrieveAPIView(SiteAppPermissionTestBase):
+
+class TestIrodsConfigRetrieveAPIView(
+    SODARAPIPermissionTestMixin, SiteAppPermissionTestBase
+):
     """Tests for irodsinfo API"""
 
+    media_type = IRODSINFO_API_MEDIA_TYPE
+    api_version = IRODSINFO_API_DEFAULT_VERSION
+
     def test_get_irods_config(self):
         """Test IrodsConfigRetrieveAPIView GET"""
         url = reverse('irodsinfo:api_env')
         good_users = [self.superuser, self.regular_user]
         bad_users = [self.anonymous]
-        self.assert_response(url, good_users, 200)
-        self.assert_response(url, bad_users, 401)
+        self.assert_response_api(url, good_users, 200)
+        self.assert_response_api(url, bad_users, 401)

irodsinfo/tests/test_views_api.py

@@ -7,11 +7,18 @@
 from test_plus.test import TestCase
 
 from irodsinfo.tests.test_views import PLUGINS_DISABLE_IRODS
+from irodsinfo.views_api import (
+    IRODSINFO_API_MEDIA_TYPE,
+    IRODSINFO_API_DEFAULT_VERSION,
+)
 
 
 class TestIrodsConfigRetrieveAPIView(TestCase):
     """Tests for IrodsConfigRetrieveAPIView"""
 
+    media_type = IRODSINFO_API_MEDIA_TYPE
+    api_version = IRODSINFO_API_DEFAULT_VERSION
+
     def setUp(self):
         # Create users
         self.superuser = self.make_user('superuser')

irodsinfo/views_api.py

@@ -3,7 +3,9 @@
 import logging
 
 from rest_framework.permissions import IsAuthenticated
+from rest_framework.renderers import JSONRenderer
 from rest_framework.response import Response
+from rest_framework.versioning import AcceptHeaderVersioning
 from rest_framework.views import APIView
 
 # Projectroles dependency
@@ -15,7 +17,32 @@
 logger = logging.getLogger(__name__)
 
 
-class IrodsEnvRetrieveAPIView(IrodsConfigMixin, APIView):
+# Local constants
+IRODSINFO_API_MEDIA_TYPE = 'application/vnd.bihealth.sodar.irodsinfo+json'
+IRODSINFO_API_ALLOWED_VERSIONS = ['1.0']
+IRODSINFO_API_DEFAULT_VERSION = '1.0'
+
+
+class IrodsinfoAPIVersioningMixin:
+    """
+    Irodsinfo API view versioning mixin for overriding media type and
+    accepted versions.
+    """
+
+    class IrodsinfoAPIRenderer(JSONRenderer):
+        media_type = IRODSINFO_API_MEDIA_TYPE
+
+    class IrodsinfoAPIVersioning(AcceptHeaderVersioning):
+        allowed_versions = IRODSINFO_API_ALLOWED_VERSIONS
+        default_version = IRODSINFO_API_DEFAULT_VERSION
+
+    renderer_classes = [IrodsinfoAPIRenderer]
+    versioning_class = IrodsinfoAPIVersioning
+
+
+class IrodsEnvRetrieveAPIView(
+    IrodsConfigMixin, IrodsinfoAPIVersioningMixin, APIView
+):
     """
     Retrieve iRODS environment file for the current user.