Enhance API documentation and schema management by implementing explicit tag configurations for Swagger and ReDoc. Introduce postprocessing hooks to filter auto-generated tags, ensuring only defined tags are used. Update viewsets across various modules to utilize the new tagging system, improving clarity and organization in API documentation.
This commit is contained in:
@@ -4,6 +4,7 @@ from rest_framework.response import Response
|
||||
from django_filters.rest_framework import DjangoFilterBackend
|
||||
from django.db import transaction, models
|
||||
from django.db.models import Q
|
||||
from drf_spectacular.utils import extend_schema, extend_schema_view
|
||||
from igny8_core.api.base import SiteSectorModelViewSet
|
||||
from igny8_core.api.pagination import CustomPageNumberPagination
|
||||
from igny8_core.api.response import success_response, error_response
|
||||
@@ -13,6 +14,14 @@ from .models import Tasks, Images, Content
|
||||
from .serializers import TasksSerializer, ImagesSerializer, ContentSerializer
|
||||
|
||||
|
||||
@extend_schema_view(
|
||||
list=extend_schema(tags=['Writer']),
|
||||
create=extend_schema(tags=['Writer']),
|
||||
retrieve=extend_schema(tags=['Writer']),
|
||||
update=extend_schema(tags=['Writer']),
|
||||
partial_update=extend_schema(tags=['Writer']),
|
||||
destroy=extend_schema(tags=['Writer']),
|
||||
)
|
||||
class TasksViewSet(SiteSectorModelViewSet):
|
||||
"""
|
||||
ViewSet for managing tasks with CRUD operations
|
||||
@@ -374,6 +383,14 @@ class TasksViewSet(SiteSectorModelViewSet):
|
||||
)
|
||||
|
||||
|
||||
@extend_schema_view(
|
||||
list=extend_schema(tags=['Writer']),
|
||||
create=extend_schema(tags=['Writer']),
|
||||
retrieve=extend_schema(tags=['Writer']),
|
||||
update=extend_schema(tags=['Writer']),
|
||||
partial_update=extend_schema(tags=['Writer']),
|
||||
destroy=extend_schema(tags=['Writer']),
|
||||
)
|
||||
class ImagesViewSet(SiteSectorModelViewSet):
|
||||
"""
|
||||
ViewSet for managing content images
|
||||
@@ -773,6 +790,14 @@ class ImagesViewSet(SiteSectorModelViewSet):
|
||||
request=request
|
||||
)
|
||||
|
||||
@extend_schema_view(
|
||||
list=extend_schema(tags=['Writer']),
|
||||
create=extend_schema(tags=['Writer']),
|
||||
retrieve=extend_schema(tags=['Writer']),
|
||||
update=extend_schema(tags=['Writer']),
|
||||
partial_update=extend_schema(tags=['Writer']),
|
||||
destroy=extend_schema(tags=['Writer']),
|
||||
)
|
||||
class ContentViewSet(SiteSectorModelViewSet):
|
||||
"""
|
||||
ViewSet for managing task content
|
||||
|
||||
Reference in New Issue
Block a user