Merge pull request #3307 from codalab/adding-api-docs

Adding API docs

Author: Didayolo

codalab/apps/api/routers.py

@@ -3,9 +3,12 @@
 from apps.api.views import admin_views as admin_views
 from django.conf.urls import url
 from rest_framework import routers
+from rest_framework.documentation import include_docs_urls
+
 
 router = routers.DefaultRouter()
 
+
 router.register(r'competition/(?P<competition_id>\d+)/participants', views.CompetitionParticipantAPIViewSet)
 router.register(r'competition', views.CompetitionAPIViewSet)
 router.register(r'competition/(?P<competition_id>\d+)/leaderboards', views.LeaderBoardViewSet)
@@ -19,17 +22,17 @@
     url(r'^competition/create/sas$', views.CompetitionCreationSasApi.as_view(), name='api_competition_creation_sas'),
     url(r'^competition/create/(?P<token>\d+)$', views.CompetitionCreationStatusApi.as_view(), name='api_competition_creation_status'),
 
-    url(r'^competition/(?P<competition_id>\d+)/submission$',views.competition_submission_create,name='api_competition_submission_post'),
-    url(r'^competition/(?P<competition_id>\d+)/submission/sas$',views.CompetitionSubmissionSasApi.as_view(), name='api_competition_submission_sas'),
-    url(r'^competition/(?P<competition_id>\d+)/submission/(?P<pk>\d+)$',views.competition_submission_retrieve,name='api_competition_submission_get'),
-    url(r'^competition/(?P<competition_id>\d+)/submission/(?P<pk>\d+)/leaderboard$',views.competition_submission_leaderboard,name='api_competition_submission_leaderboard'),
+    url(r'^competition/(?P<competition_id>\d+)/submission$', views.competition_submission_create, name='api_competition_submission_post'),
+    url(r'^competition/(?P<competition_id>\d+)/submission/sas$', views.CompetitionSubmissionSasApi.as_view(), name='api_competition_submission_sas'),
+    url(r'^competition/(?P<competition_id>\d+)/submission/(?P<pk>\d+)$', views.competition_submission_retrieve, name='api_competition_submission_get'),
+    url(r'^competition/(?P<competition_id>\d+)/submission/(?P<pk>\d+)/leaderboard$', views.competition_submission_leaderboard, name='api_competition_submission_leaderboard'),
     url(r'^competition/(?P<competition_id>\d+)/submissions/?$', views.CompetitionSubmissionListViewSet.as_view({'get': 'list'}), name='api_competition_submission_list'),
 
-    url(r'^competition/(?P<pk>\d+)/phases/(?P<phasenumber>\d+)$',views.competitionphase_retrieve,name='api_competitionphase'),
-    url(r'^competition/(?P<competition_id>\d+)/phases/(?P<phase_id>\d+)/leaderboard$',views.leaderboard_retrieve, name='api_phase_leaderboard'),
-    url(r'^competition/(?P<competition_id>\d+)/phases/(?P<phase_id>\d+)/leaderboard/data$',views.LeaderBoardDataViewSet.as_view(), name='api_phase_leaderboarddata'),
+    url(r'^competition/(?P<pk>\d+)/phases/(?P<phasenumber>\d+)$', views.competitionphase_retrieve, name='api_competitionphase'),
+    url(r'^competition/(?P<competition_id>\d+)/phases/(?P<phase_id>\d+)/leaderboard$', views.leaderboard_retrieve, name='api_phase_leaderboard'),
+    url(r'^competition/(?P<competition_id>\d+)/phases/(?P<phase_id>\d+)/leaderboard/data$', views.LeaderBoardDataViewSet.as_view(), name='api_phase_leaderboarddata'),
 
-    url(r'^competition/(?P<pk>\d+)/phases/$', views.competitionphase_list,name='api_competitionphases_list'),
+    url(r'^competition/(?P<pk>\d+)/phases/$', views.competitionphase_list, name='api_competitionphases_list'),
 
     url(r'^competition/(?P<competition_id>\d+)/pages/(?P<category>[a-zA-Z][\w\d\-\_]*)/$', views.competition_page_list, name='api_competition_page_list'),
     url(r'^competition/(?P<competition_id>\d+)/pages/(?P<pk>\d+)$', views.competition_page, name='api_competition_page'),
@@ -45,5 +48,7 @@
     url(r'^admin/competitions/list', admin_views.GetCompetitions.as_view(), name="competitions"),
     url(r'^admin/competitions/update', admin_views.UpdateCompetitions.as_view(), name="update_competitions"),
     url(r'^admin/competition/(?P<competition_id>\d+)/apply_upper_bound_limit', admin_views.ApplyUpperBoundLimit.as_view(), name="apply_upper_bound_limit"),
-    url(r'^admin/competitions/default_upper_bound_limit', admin_views.GetDefaultUpperBoundLimit.as_view(), name="get_default_upper_bound_limit")
+    url(r'^admin/competitions/default_upper_bound_limit', admin_views.GetDefaultUpperBoundLimit.as_view(), name="get_default_upper_bound_limit"),
+    # API Docs
+    url(r'^docs/', include_docs_urls(title='Codalab API Reference', public=False))
 )

codalab/apps/api/serializers.py

@@ -7,13 +7,15 @@ class ContentCategorySerial(serializers.ModelSerializer):
 
     class Meta:
         model = webmodels.ContentCategory
+        fields = '__all__'
 
 class DefaultContentSerial(serializers.ModelSerializer):
     category_codename = serializers.SlugField(source='category.codename')
     category_name = serializers.CharField(source='category.name')
     initial_visibility = serializers.SlugField(source='initial_visibility.codename')
     class Meta:
         model = webmodels.DefaultContentItem
+        fields = '__all__'
 
 
 class PageContainerSerial(serializers.ModelSerializer):
@@ -56,6 +58,7 @@ def validata_phase_id(self,attr,source):
 class CompetitionParticipantSerial(serializers.ModelSerializer):
     class Meta:
         model = webmodels.CompetitionParticipant
+        fields = '__all__'
 
 
 class CompetitionSubmissionSerial(serializers.ModelSerializer):
@@ -167,12 +170,14 @@ class LeaderBoardSerial(serializers.ModelSerializer):
     entries =  CompetitionSubmissionSerial(read_only=True, source='submissions')
     class Meta:
         model = webmodels.PhaseLeaderBoard
+        fields = '__all__'
 
 class CompetitionDataSerial(serializers.ModelSerializer):
     image_url = serializers.URLField(source='image.url', read_only=True)
     phases = serializers.RelatedField(many=True, read_only=True)
     class Meta:
         model = webmodels.Competition
+        fields = '__all__'
 
 
 class PhaseRel(serializers.ModelSerializer):
@@ -252,6 +257,7 @@ class Meta:
 class ScoreSerial(serializers.ModelSerializer):
     class Meta:
         model = webmodels.SubmissionScore
+        fields = '__all__'
 
 class CompetitionScoresSerial(serializers.ModelSerializer):
     competition_id = serializers.IntegerField(source='phase.competition.pk')
@@ -264,3 +270,4 @@ class CompetitionScoresSerial(serializers.ModelSerializer):
 
     class Meta:
         model = webmodels.CompetitionSubmission
+        fields = '__all__'

codalab/requirements/requirements.txt

@@ -85,3 +85,6 @@ pytest-env==0.6.2
 lxml==4.1.1
 
 certifi==2020.6.20
+
+# Adding coreapi for rest_framework api documentation
+coreapi