Merge pull request #137 from Ensembl/feature/swagger

Fix swagger documentation
Ensembl · Feb 27, 2023 · 0c54083 · 0c54083
2 parents ad0bd91 + 02a59f5
commit 0c54083
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -32,4 +32,9 @@ pip-delete-this-directory.txt
 .coverage
 .cache
 nosetests.xml
-coverage.xml
+coverage.xml
+
+.idea
+
+# Static files directory
+apache
diff --git a/gifts_rest/settings/base.py b/gifts_rest/settings/base.py
@@ -185,7 +185,10 @@
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/2.0/howto/static-files/
 
-STATIC_URL = '/static/'
+STATIC_URL = '/gifts/api-static/'
+
+STATIC_ROOT = os.path.join(BASE_DIR, "static/apache")
+
 
 # TaRK base URL
 TARK_SERVER = "http://tark.ensembl.org"
@@ -205,3 +208,9 @@
 CELERY_ACCEPT_CONTENT = ['application/json']
 CELERY_TASK_SERIALIZER = 'json'
 CELERY_RESULT_SERIALIZER = 'json'
+
+SWAGGER_SETTINGS = {
+    "USE_SESSION_AUTH": False,
+    "SECURITY_DEFINITIONS": {},
+    "DOC_EXPANSION": None
+}
diff --git a/gifts_rest/urls.py b/gifts_rest/urls.py
@@ -39,7 +39,7 @@
 from . import settings
 
 
-schema_view = get_swagger_view(title='GIFTs API Documentation')
+schema_view = get_swagger_view(title='GIFTs API Documentation', url='/' if settings.env.DEV_ENV else '/gifts/api/')
 
 
 if settings.env.DEV_ENV:

diff --git a/requirements.txt b/requirements.txt
@@ -6,7 +6,7 @@ djangorestframework==3.7.7
 django-cors-headers==2.4.0
 django-filter==1.1.0
 django-postgres-extra==1.21a8
-django-rest-swagger==2.2.0
+django-rest-swagger==2.1.2
 idna==2.7
 Markdown==2.6.11
 psycopg2-binary==2.7.4

diff --git a/restui/views/alignments.py b/restui/views/alignments.py
@@ -23,6 +23,7 @@
 from rest_framework.views import APIView
 from rest_framework.response import Response
 from rest_framework import status
+from rest_framework.permissions import IsAuthenticated
 
 
 import coreapi
@@ -40,6 +41,7 @@ class AlignmentRunCreate(generics.CreateAPIView):
     """
     Store an AlignmentRun
     """
+    permission_classes = (IsAuthenticated,)
 
     serializer_class = AlignmentRunSerializer
 
@@ -58,6 +60,8 @@ class AlignmentCreate(APIView):
     Insert an Alignment
     """
 
+    permission_classes = (IsAuthenticated,)
+
     def post(self, request):
 
         try:

diff --git a/restui/views/ensembl.py b/restui/views/ensembl.py
@@ -120,6 +120,8 @@ class EnspUCigarCreate(generics.CreateAPIView):
     Insert an alignment
     """
 
+    permission_classes = (IsAuthenticated,)
+
     serializer_class = EnspUCigarSerializer
 
 
@@ -185,7 +187,7 @@ class EnspUCigarFetchUpdateByAlignment(generics.RetrieveUpdateAPIView):
     """
     Fetch/Update cigar/mdz by alignment id
     """
-
+    permission_classes = (IsAuthenticated,)
     serializer_class = EnspUCigarSerializer
     schema = ManualSchema(description="Fetch/Update cigar/mdz by alignment id",
                           fields=[