Implement unified API standard across backend viewsets and serializers, enhancing error handling and response formatting. Update AccountModelViewSet to standardize CRUD operations with success and error responses. Refactor various viewsets to inherit from AccountModelViewSet, ensuring compliance with the new standard. Improve frontend components to handle API responses consistently and update configuration for better user experience.
This commit is contained in:
@@ -119,7 +119,7 @@ class GroupsViewSet(viewsets.ViewSet):
|
||||
# 2. USERS - Manage global user records and credentials
|
||||
# ============================================================================
|
||||
|
||||
class UsersViewSet(viewsets.ModelViewSet):
|
||||
class UsersViewSet(AccountModelViewSet):
|
||||
"""
|
||||
ViewSet for managing global user records and credentials.
|
||||
Users are global, but belong to accounts.
|
||||
@@ -246,13 +246,17 @@ class UsersViewSet(viewsets.ModelViewSet):
|
||||
# 3. ACCOUNTS - Register each unique organization/user space
|
||||
# ============================================================================
|
||||
|
||||
class AccountsViewSet(viewsets.ModelViewSet):
|
||||
class AccountsViewSet(AccountModelViewSet):
|
||||
"""
|
||||
ViewSet for managing accounts (unique organization/user spaces).
|
||||
Unified API Standard v1.0 compliant
|
||||
"""
|
||||
queryset = Account.objects.all()
|
||||
serializer_class = AccountSerializer
|
||||
permission_classes = [IsOwnerOrAdmin]
|
||||
pagination_class = CustomPageNumberPagination
|
||||
throttle_scope = 'auth'
|
||||
throttle_classes = [DebugScopedRateThrottle]
|
||||
|
||||
def get_queryset(self):
|
||||
"""Return accounts based on access level."""
|
||||
@@ -299,12 +303,16 @@ class AccountsViewSet(viewsets.ModelViewSet):
|
||||
# 4. SUBSCRIPTIONS - Control plan level, limits, and billing per account
|
||||
# ============================================================================
|
||||
|
||||
class SubscriptionsViewSet(viewsets.ModelViewSet):
|
||||
class SubscriptionsViewSet(AccountModelViewSet):
|
||||
"""
|
||||
ViewSet for managing subscriptions (plan level, limits, billing per account).
|
||||
Unified API Standard v1.0 compliant
|
||||
"""
|
||||
queryset = Subscription.objects.all()
|
||||
permission_classes = [IsOwnerOrAdmin]
|
||||
pagination_class = CustomPageNumberPagination
|
||||
throttle_scope = 'auth'
|
||||
throttle_classes = [DebugScopedRateThrottle]
|
||||
|
||||
def get_queryset(self):
|
||||
"""Return subscriptions based on access level."""
|
||||
@@ -348,13 +356,17 @@ class SubscriptionsViewSet(viewsets.ModelViewSet):
|
||||
# 5. SITE USER ACCESS - Assign users access to specific sites within account
|
||||
# ============================================================================
|
||||
|
||||
class SiteUserAccessViewSet(viewsets.ModelViewSet):
|
||||
class SiteUserAccessViewSet(AccountModelViewSet):
|
||||
"""
|
||||
ViewSet for managing Site-User access permissions.
|
||||
Assign users access to specific sites within their account.
|
||||
Unified API Standard v1.0 compliant
|
||||
"""
|
||||
serializer_class = SiteUserAccessSerializer
|
||||
permission_classes = [IsOwnerOrAdmin]
|
||||
pagination_class = CustomPageNumberPagination
|
||||
throttle_scope = 'auth'
|
||||
throttle_classes = [DebugScopedRateThrottle]
|
||||
|
||||
def get_queryset(self):
|
||||
"""Return access records for sites in user's account."""
|
||||
@@ -383,10 +395,29 @@ class SiteUserAccessViewSet(viewsets.ModelViewSet):
|
||||
# ============================================================================
|
||||
|
||||
class PlanViewSet(viewsets.ReadOnlyModelViewSet):
|
||||
"""ViewSet for listing active subscription plans."""
|
||||
"""
|
||||
ViewSet for listing active subscription plans.
|
||||
Unified API Standard v1.0 compliant
|
||||
"""
|
||||
queryset = Plan.objects.filter(is_active=True)
|
||||
serializer_class = PlanSerializer
|
||||
permission_classes = [permissions.AllowAny]
|
||||
pagination_class = CustomPageNumberPagination
|
||||
throttle_scope = 'auth'
|
||||
throttle_classes = [DebugScopedRateThrottle]
|
||||
|
||||
def retrieve(self, request, *args, **kwargs):
|
||||
"""Override retrieve to return unified format"""
|
||||
try:
|
||||
instance = self.get_object()
|
||||
serializer = self.get_serializer(instance)
|
||||
return success_response(data=serializer.data, request=request)
|
||||
except Exception as e:
|
||||
return error_response(
|
||||
error=str(e),
|
||||
status_code=status.HTTP_404_NOT_FOUND,
|
||||
request=request
|
||||
)
|
||||
|
||||
|
||||
class SiteViewSet(AccountModelViewSet):
|
||||
@@ -662,10 +693,16 @@ class SectorViewSet(AccountModelViewSet):
|
||||
|
||||
|
||||
class IndustryViewSet(viewsets.ReadOnlyModelViewSet):
|
||||
"""ViewSet for industry templates."""
|
||||
"""
|
||||
ViewSet for industry templates.
|
||||
Unified API Standard v1.0 compliant
|
||||
"""
|
||||
queryset = Industry.objects.filter(is_active=True).prefetch_related('sectors')
|
||||
serializer_class = IndustrySerializer
|
||||
permission_classes = [permissions.AllowAny]
|
||||
pagination_class = CustomPageNumberPagination
|
||||
throttle_scope = 'auth'
|
||||
throttle_classes = [DebugScopedRateThrottle]
|
||||
|
||||
def list(self, request):
|
||||
"""Get all industries with their sectors."""
|
||||
@@ -675,13 +712,32 @@ class IndustryViewSet(viewsets.ReadOnlyModelViewSet):
|
||||
data={'industries': serializer.data},
|
||||
request=request
|
||||
)
|
||||
|
||||
def retrieve(self, request, *args, **kwargs):
|
||||
"""Override retrieve to return unified format"""
|
||||
try:
|
||||
instance = self.get_object()
|
||||
serializer = self.get_serializer(instance)
|
||||
return success_response(data=serializer.data, request=request)
|
||||
except Exception as e:
|
||||
return error_response(
|
||||
error=str(e),
|
||||
status_code=status.HTTP_404_NOT_FOUND,
|
||||
request=request
|
||||
)
|
||||
|
||||
|
||||
class SeedKeywordViewSet(viewsets.ReadOnlyModelViewSet):
|
||||
"""ViewSet for SeedKeyword - Global reference data (read-only for non-admins)."""
|
||||
"""
|
||||
ViewSet for SeedKeyword - Global reference data (read-only for non-admins).
|
||||
Unified API Standard v1.0 compliant
|
||||
"""
|
||||
queryset = SeedKeyword.objects.filter(is_active=True).select_related('industry', 'sector')
|
||||
serializer_class = SeedKeywordSerializer
|
||||
permission_classes = [permissions.AllowAny] # Read-only, allow any authenticated user
|
||||
pagination_class = CustomPageNumberPagination
|
||||
throttle_scope = 'auth'
|
||||
throttle_classes = [DebugScopedRateThrottle]
|
||||
|
||||
filter_backends = [filters.SearchFilter, filters.OrderingFilter, DjangoFilterBackend]
|
||||
search_fields = ['keyword']
|
||||
@@ -689,6 +745,19 @@ class SeedKeywordViewSet(viewsets.ReadOnlyModelViewSet):
|
||||
ordering = ['keyword']
|
||||
filterset_fields = ['industry', 'sector', 'intent', 'is_active']
|
||||
|
||||
def retrieve(self, request, *args, **kwargs):
|
||||
"""Override retrieve to return unified format"""
|
||||
try:
|
||||
instance = self.get_object()
|
||||
serializer = self.get_serializer(instance)
|
||||
return success_response(data=serializer.data, request=request)
|
||||
except Exception as e:
|
||||
return error_response(
|
||||
error=str(e),
|
||||
status_code=status.HTTP_404_NOT_FOUND,
|
||||
request=request
|
||||
)
|
||||
|
||||
def get_queryset(self):
|
||||
"""Filter by industry and sector if provided."""
|
||||
queryset = super().get_queryset()
|
||||
|
||||
Reference in New Issue
Block a user