From 98c60cf90f511f828d3e7bc3d7891b2809d27db6 Mon Sep 17 00:00:00 2001
From: ks129 <45097959+ks129@users.noreply.github.com>
Date: Wed, 24 Feb 2021 08:47:25 +0200
Subject: Add comment about manually defining nomination field of
 NominationEntry serializer

---
 pydis_site/apps/api/serializers.py | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'pydis_site/apps/api/serializers.py')

diff --git a/pydis_site/apps/api/serializers.py b/pydis_site/apps/api/serializers.py
index 17dd4b3d..f47bedca 100644
--- a/pydis_site/apps/api/serializers.py
+++ b/pydis_site/apps/api/serializers.py
@@ -342,6 +342,9 @@ class UserSerializer(ModelSerializer):
 class NominationEntrySerializer(ModelSerializer):
     """A class providing (de-)serialization of `NominationEntry` instances."""
 
+    # We need to define it here, because we don't want that nomination ID
+    # return inside nomination response entry, because ID is already available
+    # as top-level field. Queryset is required if field is not read only.
     nomination = PrimaryKeyRelatedField(
         queryset=Nomination.objects.all(),
         write_only=True
-- 
cgit v1.2.3