feat / AEB-64 create alert routes
This commit is contained in:
35
backend/api/account/serializers/alert_serializers.py
Normal file
35
backend/api/account/serializers/alert_serializers.py
Normal file
@@ -0,0 +1,35 @@
|
||||
from rest_framework import serializers
|
||||
from drf_spectacular.utils import extend_schema_field
|
||||
from drf_spectacular.types import OpenApiTypes
|
||||
from typing import Optional
|
||||
from sitemanagement.models import Alert
|
||||
|
||||
class AlertSerializer(serializers.ModelSerializer):
|
||||
name = serializers.SerializerMethodField()
|
||||
object = serializers.SerializerMethodField()
|
||||
metric_value = serializers.SerializerMethodField()
|
||||
sensor_type_name = serializers.SerializerMethodField()
|
||||
|
||||
class Meta:
|
||||
model = Alert
|
||||
fields = ('id', 'name', 'object', 'metric_value', 'sensor_type_name', 'message', 'severity', 'created_at', 'resolved')
|
||||
|
||||
@extend_schema_field(OpenApiTypes.STR)
|
||||
def get_name(self, obj) -> str:
|
||||
return obj.sensor.name
|
||||
|
||||
@extend_schema_field(OpenApiTypes.STR)
|
||||
def get_object(self, obj) -> Optional[str]:
|
||||
zone = obj.sensor.zones.first()
|
||||
return zone.object.title if zone else None
|
||||
|
||||
@extend_schema_field(OpenApiTypes.STR)
|
||||
def get_metric_value(self, obj) -> str:
|
||||
if obj.metric.value is not None:
|
||||
unit = obj.sensor.signal_format.unit if obj.sensor.signal_format else ''
|
||||
return f"{obj.metric.value} {unit}".strip()
|
||||
return obj.metric.raw_value
|
||||
|
||||
@extend_schema_field(OpenApiTypes.STR)
|
||||
def get_sensor_type_name(self, obj) -> str:
|
||||
return obj.sensor_type.name
|
||||
@@ -1,5 +1,8 @@
|
||||
from rest_framework import serializers
|
||||
from django.conf import settings
|
||||
from drf_spectacular.utils import extend_schema_field
|
||||
from drf_spectacular.types import OpenApiTypes
|
||||
from typing import Optional
|
||||
from sitemanagement.models import Object, Zone, Sensor
|
||||
|
||||
class SensorBasicSerializer(serializers.ModelSerializer):
|
||||
@@ -22,6 +25,7 @@ class ObjectSerializer(serializers.ModelSerializer):
|
||||
model = Object
|
||||
fields = ('id', 'title', 'description', 'image', 'address', 'floors', 'area', 'zones')
|
||||
|
||||
def get_image(self, obj):
|
||||
@extend_schema_field(OpenApiTypes.URI)
|
||||
def get_image(self, obj) -> Optional[str]:
|
||||
"""Возвращает URL изображения объекта"""
|
||||
return f"{settings.BASE_URL}{obj.image.url}" if obj.image else None
|
||||
@@ -1,4 +1,7 @@
|
||||
from rest_framework import serializers
|
||||
from drf_spectacular.utils import extend_schema_field
|
||||
from drf_spectacular.types import OpenApiTypes
|
||||
from typing import Dict, Any
|
||||
from sitemanagement.models import Sensor, Alert
|
||||
|
||||
class NotificationSerializer(serializers.ModelSerializer):
|
||||
@@ -76,7 +79,8 @@ class DetectorSerializer(serializers.ModelSerializer):
|
||||
class DetectorsResponseSerializer(serializers.Serializer):
|
||||
detectors = serializers.SerializerMethodField()
|
||||
|
||||
def get_detectors(self, sensors):
|
||||
@extend_schema_field(OpenApiTypes.OBJECT)
|
||||
def get_detectors(self, sensors) -> Dict[str, Any]:
|
||||
detector_serializer = DetectorSerializer(sensors, many=True)
|
||||
return {
|
||||
sensor['detector_id']: sensor
|
||||
|
||||
@@ -2,6 +2,7 @@ from django.urls import path
|
||||
from .views.UserDataView import UserDataView
|
||||
from .views.objects_views import ObjectView
|
||||
from .views.sensors_views import SensorView
|
||||
from .views.alert_views import AlertView
|
||||
from drf_spectacular.views import (
|
||||
SpectacularAPIView,
|
||||
SpectacularSwaggerView,
|
||||
@@ -23,6 +24,11 @@ urlpatterns = [
|
||||
),
|
||||
|
||||
path("user/", UserDataView.as_view(), name="user-data"),
|
||||
|
||||
path("get-objects/", ObjectView.as_view(), name="objects"),
|
||||
|
||||
path("get-detectors/", SensorView.as_view(), name="detectors"),
|
||||
|
||||
path("get-alerts/", AlertView.as_view({'get': 'get_alerts'}), name="alerts"),
|
||||
path("update-alert/<int:pk>/", AlertView.as_view({'patch': 'change_alert_status'}), name="update-alert"),
|
||||
]
|
||||
|
||||
81
backend/api/account/views/alert_views.py
Normal file
81
backend/api/account/views/alert_views.py
Normal file
@@ -0,0 +1,81 @@
|
||||
from rest_framework import status, serializers
|
||||
from rest_framework.viewsets import ViewSet
|
||||
from rest_framework.permissions import IsAuthenticated
|
||||
from drf_spectacular.utils import extend_schema, OpenApiResponse, OpenApiExample
|
||||
from rest_framework.decorators import action
|
||||
from rest_framework.response import Response
|
||||
from api.account.serializers.alert_serializers import AlertSerializer
|
||||
from sitemanagement.models import Alert
|
||||
from api.utils.decorators import handle_exceptions
|
||||
from api.utils.error_serializer import ErrorResponseSerializer
|
||||
|
||||
@extend_schema(tags=['Алерты'])
|
||||
class AlertView(ViewSet):
|
||||
permission_classes = [IsAuthenticated]
|
||||
|
||||
@extend_schema(
|
||||
summary="Получение списка алертов",
|
||||
description="Возвращает список всех алертов в системе",
|
||||
responses={
|
||||
200: OpenApiResponse(response=AlertSerializer(many=True), description="Список алертов успешно получен",
|
||||
examples=[OpenApiExample(
|
||||
'Успешный ответ',
|
||||
value=[{
|
||||
"id": 1,
|
||||
"name": "Датчик 1",
|
||||
"object": "Объект 1",
|
||||
"metric_value": "12.5 °C",
|
||||
"sensor_type_name": "Инклинометр",
|
||||
"message": "alert message",
|
||||
"severity": "warning",
|
||||
"created_at": "2025-10-06T15:53:11.759725+03:00",
|
||||
"resolved": False
|
||||
}]
|
||||
)])
|
||||
})
|
||||
|
||||
@action(detail=False, methods=['get'])
|
||||
@handle_exceptions
|
||||
def get_alerts(self, request):
|
||||
alerts = Alert.objects.all()
|
||||
serializer = AlertSerializer(alerts, many=True)
|
||||
return Response(serializer.data)
|
||||
|
||||
@extend_schema(
|
||||
summary="Изменение статуса алерта",
|
||||
description="Изменяет статус обработки алерта на противоположный",
|
||||
responses={
|
||||
200: OpenApiResponse(response=AlertSerializer, description="Статус алерта успешно изменен",
|
||||
examples=[OpenApiExample(
|
||||
'Успешный ответ',
|
||||
value={
|
||||
"message": "Статус алерта успешно изменен"
|
||||
}
|
||||
)]),
|
||||
404: OpenApiResponse(
|
||||
response=ErrorResponseSerializer,
|
||||
description="Алерт не найден",
|
||||
examples=[
|
||||
OpenApiExample(
|
||||
'Алерт не найден',
|
||||
value={"error": "Алерт не найден"},
|
||||
status_codes=['404']
|
||||
)
|
||||
]
|
||||
)
|
||||
})
|
||||
@action(detail=True, methods=['patch'])
|
||||
@handle_exceptions
|
||||
def change_alert_status(self, request, pk=None):
|
||||
try:
|
||||
alert = Alert.objects.get(pk=pk)
|
||||
alert.resolved = not alert.resolved
|
||||
alert.save()
|
||||
|
||||
return Response({"message": "Статус алерта успешно изменен"}, status=status.HTTP_200_OK)
|
||||
|
||||
except Alert.DoesNotExist:
|
||||
return Response(
|
||||
{"error": "Алерт не найден"},
|
||||
status=status.HTTP_404_NOT_FOUND)
|
||||
|
||||
@@ -24,7 +24,7 @@ class ObjectView(APIView):
|
||||
"id": 1,
|
||||
"title": "Объект 1",
|
||||
"description": "Описание объекта 1",
|
||||
"image": "https://example.com/image.jpg",
|
||||
"image": "https://aerbim.org/media/image.jpg",
|
||||
"address": "Адрес объекта 1",
|
||||
"floors": 1,
|
||||
"area": 100.0,
|
||||
|
||||
5
backend/api/utils/error_serializer.py
Normal file
5
backend/api/utils/error_serializer.py
Normal file
@@ -0,0 +1,5 @@
|
||||
from rest_framework import serializers
|
||||
|
||||
class ErrorResponseSerializer(serializers.Serializer):
|
||||
"""Сериализатор для ответа с ошибкой"""
|
||||
error = serializers.CharField(help_text="Текст ошибки")
|
||||
Reference in New Issue
Block a user