Added description for domain viewset routes.

This commit is contained in:
Antoine Nguyen
2020-11-09 21:20:18 +01:00
parent 591f9b9a1d
commit 78a772eaf1
2 changed files with 21 additions and 10 deletions
+16 -9
View File
@@ -4,6 +4,7 @@ from django import http
from django.contrib.contenttypes.models import ContentType
from django.utils.translation import ugettext as _
from drf_spectacular.utils import extend_schema, extend_schema_view
from rest_framework import filters, status, viewsets
from rest_framework.decorators import action
from rest_framework.exceptions import ParseError
@@ -16,16 +17,22 @@ from modoboa.core import sms_backends
from . import lib, models, serializers
@extend_schema_view(
retrieve=extend_schema(
description="Retrieve a particular domain",
summary="Retrieve a particular domain"
),
list=extend_schema(
description="Retrieve a list of domains",
summary="Retrieve a list of domains"
),
create=extend_schema(
description="Create a new domain",
summary="Create a new domain"
)
)
class DomainViewSet(viewsets.ModelViewSet):
"""
Domain viewset.
retrieve: Return the given domain.
list: Return a list of all existing domains.
create: Create a new domain instance.
"""
"""Domain viewset."""
permission_classes = [IsAuthenticated, DjangoModelPermissions, ]
serializer_class = serializers.DomainSerializer
+5 -1
View File
@@ -8,7 +8,9 @@ from django.contrib.auth.decorators import login_required
from django.urls import include, path
from django.views.i18n import JavaScriptCatalog
from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView
from drf_spectacular.views import (
SpectacularAPIView, SpectacularSwaggerView, SpectacularRedocView
)
from modoboa.admin.views import user as user_views
from modoboa.core import signals as core_signals, views as core_views
@@ -62,6 +64,8 @@ urlpatterns += [
path('docs/api/',
SpectacularSwaggerView.as_view(url_name='schema'),
name='docs-index'),
path('docs/api/redoc/', SpectacularRedocView.as_view(url_name='schema'),
name='redoc'),
path('api/v1/', include("modoboa.urls_api")),
]