oncall-engine/engine/apps/api/serializers/slack_channel.py

import typing

from rest_framework import serializers

from apps.slack.models import SlackChannel


class SlackChannelDetails(typing.TypedDict):
    display_name: str
    slack_id: str
    id: str


class SlackChannelSerializer(serializers.ModelSerializer):
    id = serializers.CharField(read_only=True, source="public_primary_key")
    display_name = serializers.CharField(source="name")

    class Meta:
        model = SlackChannel
        fields = ["id", "display_name", "slack_id"]
        read_only_fields = ["id", "display_name", "slack_id"]