Implemented documentation for REST API: /api/docs/

cvat/apps/engine/__init__.py

@@ -1,3 +1,17 @@
 # Copyright (C) 2018 Intel Corporation
 #
 # SPDX-License-Identifier: MIT
+
+from rest_framework import versioning
+
+class URLPathVersioning(versioning.URLPathVersioning):
+    def determine_version(self, request, *args, **kwargs):
+        # When you try to specify a version (e.g /api/v1/docs) it will generate
+        # an error inside a template of Rest Framework (reverse of an URL
+        # without argument). Also when you try don't use version at all it will
+        # give you an error 'invalid version'. To avoid these problems just
+        # redefine determine_version for /api/docs/*.
+        if request.path.startswith('/api/docs/'):
+            return None
+
+        return super().determine_version(request, *args, **kwargs)

cvat/apps/engine/urls.py

@@ -6,6 +6,7 @@
 from django.urls import path, include
 from . import views
 from rest_framework import routers
+from rest_framework.documentation import include_docs_urls
 
 REST_API_PREFIX = 'api/<version>/'
 
@@ -15,11 +16,17 @@
 router.register("users", views.UserViewSet)
 
 urlpatterns = [
+    # documentation for API
+    path('api/docs/', include_docs_urls(title='CVAT REST API')),
     # entry point for API
     path(REST_API_PREFIX, include(router.urls)),
     # GET a frame for a specific task
     path(REST_API_PREFIX + 'tasks/<int:pk>/frames/<int:frame>',
         views.get_frame, name='task-frame'),
+    # GET meta information for all frames
+    path(REST_API_PREFIX + 'tasks/<int:pk>/frames/meta',
+        views.get_image_meta_cache, name='image-meta-cache'),
+
     # POST an exception
     path(REST_API_PREFIX + 'exceptions/', views.ClientException.as_view(),
         name='exception-list'),
@@ -28,9 +35,6 @@
     path( # PUT
         REST_API_PREFIX + 'tasks/<int:pk>/data', views.dummy_view,
         name='task-data'),
-    # GET meta information for all frames
-    path(REST_API_PREFIX + 'tasks/<int:pk>/frames/meta',
-        views.get_image_meta_cache, name='image-meta-cache'),
 
 
 

cvat/apps/engine/views.py

@@ -40,6 +40,10 @@
 
 # Server REST API
 
+#class ServerViewSet(viewsets.)
+
+
+
 class TaskViewSet(viewsets.ModelViewSet):
     queryset = Task.objects.all()
     serializer_class = TaskSerializer

cvat/settings/base.py

@@ -107,7 +107,7 @@ def generate_ssh_keys():
         'rest_framework.permissions.IsAuthenticated',
     ],
     'DEFAULT_VERSIONING_CLASS':
-        'rest_framework.versioning.URLPathVersioning',
+        'cvat.apps.engine.URLPathVersioning',
     'ALLOWED_VERSIONS': ('v1', ),
     'DEFAULT_PAGINATION_CLASS':
         'rest_framework.pagination.PageNumberPagination',