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:
@@ -8,6 +8,7 @@ from django.http import HttpResponse
|
||||
import csv
|
||||
import json
|
||||
import time
|
||||
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
|
||||
@@ -18,6 +19,14 @@ from .serializers import KeywordSerializer, ContentIdeasSerializer
|
||||
from .cluster_serializers import ClusterSerializer
|
||||
|
||||
|
||||
@extend_schema_view(
|
||||
list=extend_schema(tags=['Planner']),
|
||||
create=extend_schema(tags=['Planner']),
|
||||
retrieve=extend_schema(tags=['Planner']),
|
||||
update=extend_schema(tags=['Planner']),
|
||||
partial_update=extend_schema(tags=['Planner']),
|
||||
destroy=extend_schema(tags=['Planner']),
|
||||
)
|
||||
class KeywordViewSet(SiteSectorModelViewSet):
|
||||
"""
|
||||
ViewSet for managing keywords with CRUD operations
|
||||
@@ -662,6 +671,14 @@ class KeywordViewSet(SiteSectorModelViewSet):
|
||||
)
|
||||
|
||||
|
||||
@extend_schema_view(
|
||||
list=extend_schema(tags=['Planner']),
|
||||
create=extend_schema(tags=['Planner']),
|
||||
retrieve=extend_schema(tags=['Planner']),
|
||||
update=extend_schema(tags=['Planner']),
|
||||
partial_update=extend_schema(tags=['Planner']),
|
||||
destroy=extend_schema(tags=['Planner']),
|
||||
)
|
||||
class ClusterViewSet(SiteSectorModelViewSet):
|
||||
"""
|
||||
ViewSet for managing clusters with CRUD operations
|
||||
@@ -952,6 +969,14 @@ class ClusterViewSet(SiteSectorModelViewSet):
|
||||
)
|
||||
|
||||
|
||||
@extend_schema_view(
|
||||
list=extend_schema(tags=['Planner']),
|
||||
create=extend_schema(tags=['Planner']),
|
||||
retrieve=extend_schema(tags=['Planner']),
|
||||
update=extend_schema(tags=['Planner']),
|
||||
partial_update=extend_schema(tags=['Planner']),
|
||||
destroy=extend_schema(tags=['Planner']),
|
||||
)
|
||||
class ContentIdeasViewSet(SiteSectorModelViewSet):
|
||||
"""
|
||||
ViewSet for managing content ideas with CRUD operations
|
||||
|
||||
Reference in New Issue
Block a user