From 79b3b37736c273c80087b4678b660eb5707264a3 Mon Sep 17 00:00:00 2001
From: Erwan Rouchet <rouchet@teklia.com>
Date: Thu, 26 Nov 2020 19:56:46 +0000
Subject: [PATCH] Fix Transkribus endpoint names and add tags to job endpoints
---
arkindex/project/api_v1.py | 4 ++--
arkindex/users/api.py | 12 +++++++++---
arkindex/users/serializers.py | 2 +-
3 files changed, 12 insertions(+), 6 deletions(-)
diff --git a/arkindex/project/api_v1.py b/arkindex/project/api_v1.py
index 7ea833e6f1..38063bb11b 100644
--- a/arkindex/project/api_v1.py
+++ b/arkindex/project/api_v1.py
@@ -97,12 +97,12 @@ from arkindex.users.api import (
PasswordReset,
PasswordResetConfirm,
ProvidersList,
- UpdateUserTranskribus,
UserCreate,
UserEmailLogin,
UserEmailVerification,
UserMemberships,
UserRetrieve,
+ UserTranskribus,
)
# Cache the OpenAPI schema view for a day
@@ -247,7 +247,7 @@ api = [
path('user/token/', UserEmailVerification.as_view(), name='user-token'),
path('user/password-reset/', PasswordReset.as_view(), name='password-reset'),
path('user/password-reset/confirm/', PasswordResetConfirm.as_view(), name='password-reset-confirm'),
- path('user/transkribus/', UpdateUserTranskribus.as_view(), name='user-transkribus'),
+ path('user/transkribus/', UserTranskribus.as_view(), name='user-transkribus'),
# Rights management
path('groups/', GroupsList.as_view(), name='groups-list'),
diff --git a/arkindex/users/api.py b/arkindex/users/api.py
index 729486aeb9..736fcca7d7 100644
--- a/arkindex/users/api.py
+++ b/arkindex/users/api.py
@@ -47,8 +47,8 @@ from arkindex.users.serializers import (
OAuthRetrySerializer,
PasswordResetConfirmSerializer,
PasswordResetSerializer,
- UpdateUserTranskribusSerializer,
UserSerializer,
+ UserTranskribusSerializer,
)
logger = logging.getLogger(__name__)
@@ -341,13 +341,13 @@ class PasswordResetConfirm(CreateAPIView):
}
-class UpdateUserTranskribus(UpdateAPIView):
+class UserTranskribus(UpdateAPIView):
"""
Update and validate Transkribus account
Only the user's email is stored in our database
"""
permission_classes = (IsVerified, )
- serializer_class = UpdateUserTranskribusSerializer
+ serializer_class = UserTranskribusSerializer
openapi_overrides = {
'tags': ['users'],
}
@@ -474,6 +474,9 @@ class JobList(ListAPIView):
"""
List asynchronous jobs linked to the current user.
"""
+ openapi_overrides = {
+ 'tags': ['jobs']
+ }
permission_classes = (IsVerified, )
serializer_class = JobSerializer
pagination_class = None
@@ -488,6 +491,9 @@ class JobRetrieve(RetrieveDestroyAPIView):
"""
Retrieve a single job by ID.
"""
+ openapi_overrides = {
+ 'tags': ['jobs']
+ }
permission_classes = (IsVerified, )
serializer_class = JobSerializer
diff --git a/arkindex/users/serializers.py b/arkindex/users/serializers.py
index 5c0b0520ce..270feacff6 100644
--- a/arkindex/users/serializers.py
+++ b/arkindex/users/serializers.py
@@ -187,7 +187,7 @@ class PasswordResetConfirmSerializer(serializers.Serializer):
user.save()
-class UpdateUserTranskribusSerializer(serializers.Serializer):
+class UserTranskribusSerializer(serializers.Serializer):
"""
A serializer that allows to verify Transkribus credentials
and to save the Transkribus email
--
GitLab