oncall-engine/engine/apps/public_api/serializers/resolution_notes.py
Michael Derynck 60ef4348f5
Allow OnCall API to use Grafana Service Accounts (#3189)
# What this PR does
Allows public OnCall API to use Grafana service accounts for
authorization. In cloud requests using a Grafana service account token
also needs to provide headers for `X-Grafana-Org-Slug` and
`X-Grafana-Instance-Slug`

This is **alpha** functionality, it may break or be removed in the
future. Going to use this on one endpoint (resolution notes) before we
consider the implications across all of public API.

## Which issue(s) this PR fixes

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)
2023-11-23 16:42:27 +00:00

54 lines
2 KiB
Python

from rest_framework import serializers
from apps.alerts.models import AlertGroup, ResolutionNote
from common.api_helpers.custom_fields import OrganizationFilteredPrimaryKeyRelatedField, UserIdField
from common.api_helpers.exceptions import BadRequest
from common.api_helpers.mixins import EagerLoadingMixin
class ResolutionNoteSerializer(EagerLoadingMixin, serializers.ModelSerializer):
id = serializers.CharField(read_only=True, source="public_primary_key")
alert_group_id = OrganizationFilteredPrimaryKeyRelatedField(
queryset=AlertGroup.objects,
source="alert_group",
filter_field="channel__organization",
)
text = serializers.CharField(allow_null=False, source="message_text")
source = serializers.CharField(read_only=True, source="get_source_display")
author = UserIdField(read_only=True)
class Meta:
model = ResolutionNote
fields = [
"id",
"alert_group_id",
"author",
"source",
"created_at",
"text",
]
read_only_fields = [
"created_at",
]
SELECT_RELATED = ["alert_group", "resolution_note_slack_message", "author"]
def create(self, validated_data):
if self.context["request"].user.pk:
validated_data["author"] = self.context["request"].user
validated_data["source"] = ResolutionNote.Source.WEB
return super().create(validated_data)
def to_representation(self, instance):
result = super().to_representation(instance)
result["text"] = instance.text
return result
class ResolutionNoteUpdateSerializer(ResolutionNoteSerializer):
alert_group_id = serializers.CharField(read_only=True, source="alert_group.public_primary_key")
def update(self, instance, validated_data):
if instance.source != ResolutionNote.Source.WEB:
raise BadRequest(detail="Cannot update message with this source type")
return super().update(instance, validated_data)