oncall-engine/engine/apps/public_api/serializers/alert_groups.py
Matias Bordese a416863a28
Update alert groups public API filters support (#4832)
Related to https://github.com/grafana/oncall/issues/4747

- include labels in response
- allow filtering by labels
- allow filtering by started_at
- update docs
2024-08-15 19:58:25 +00:00

58 lines
2 KiB
Python

from rest_framework import serializers
from apps.alerts.models import AlertGroup
from apps.api.serializers.alert_group import AlertGroupLabelSerializer
from common.api_helpers.custom_fields import TeamPrimaryKeyRelatedField, UserIdField
from common.api_helpers.mixins import EagerLoadingMixin
class AlertGroupSerializer(EagerLoadingMixin, serializers.ModelSerializer):
id = serializers.CharField(read_only=True, source="public_primary_key")
integration_id = serializers.CharField(source="channel.public_primary_key")
team_id = TeamPrimaryKeyRelatedField(source="channel.team", allow_null=True)
route_id = serializers.SerializerMethodField()
created_at = serializers.DateTimeField(source="started_at")
alerts_count = serializers.SerializerMethodField()
title = serializers.SerializerMethodField()
state = serializers.SerializerMethodField()
acknowledged_by = UserIdField(read_only=True, source="acknowledged_by_user")
resolved_by = UserIdField(read_only=True, source="resolved_by_user")
labels = AlertGroupLabelSerializer(many=True, read_only=True)
SELECT_RELATED = ["channel", "channel_filter", "slack_message", "channel__organization", "channel__team"]
PREFETCH_RELATED = ["labels"]
class Meta:
model = AlertGroup
fields = [
"id",
"integration_id",
"team_id",
"route_id",
"alerts_count",
"state",
"created_at",
"resolved_at",
"resolved_by",
"acknowledged_at",
"acknowledged_by",
"labels",
"title",
"permalinks",
"silenced_at",
]
def get_title(self, obj):
return obj.web_title_cache
def get_alerts_count(self, obj):
return obj.alerts.count()
def get_state(self, obj):
return obj.state
def get_route_id(self, obj):
if obj.channel_filter is not None:
return obj.channel_filter.public_primary_key
else:
return None