Add another AllowDenyList field, 'comment'.

This will be used to describe or justify the entries in the blacklist or
whitelist, for example for the guild name in the case of guild invite
IDs, so that we have some context when we're displaying the list.

https://github.com/python-discord/site/issues/305

4 files changed, 9 insertions, 1 deletions

diff --git a/pydis_site/apps/api/migrations/0057_create_new_allowdenylist_model.py b/pydis_site/apps/api/migrations/0057_create_new_allowdenylist_model.py
index c450344b..d36acd70 100644
--- a/pydis_site/apps/api/migrations/0057_create_new_allowdenylist_model.py
+++ b/pydis_site/apps/api/migrations/0057_create_new_allowdenylist_model.py
@@ -22,6 +22,7 @@ class Migration(migrations.Migration):
                     help_text='The type of allowlist this is on.', max_length=50)),
                 ('allowed', models.BooleanField(help_text='Whether this item is on the allowlist or the denylist.')),
                 ('content', models.TextField(help_text='The data to add to the allow or denylist.')),
+                ('comment', models.TextField(help_text="Optional comment on this entry.", null=True)),
             ],
             bases=(pydis_site.apps.api.models.mixins.ModelReprMixin, models.Model),
         ),
diff --git a/pydis_site/apps/api/models/bot/allow_deny_list.py b/pydis_site/apps/api/models/bot/allow_deny_list.py
index 1eef47ba..b95dd72e 100644
--- a/pydis_site/apps/api/models/bot/allow_deny_list.py
+++ b/pydis_site/apps/api/models/bot/allow_deny_list.py
@@ -24,6 +24,10 @@ class AllowDenyList(ModelTimestampMixin, ModelReprMixin, models.Model):
     content = models.TextField(
         help_text="The data to add to the allow or denylist."
     )
+    comment = models.TextField(
+        help_text="Optional comment on this entry.",
+        null=True
+    )
 
     class Meta:
         """Metaconfig for this model."""
diff --git a/pydis_site/apps/api/serializers.py b/pydis_site/apps/api/serializers.py
index d532dd69..50f27f1d 100644
--- a/pydis_site/apps/api/serializers.py
+++ b/pydis_site/apps/api/serializers.py
@@ -111,7 +111,7 @@ class AllowDenyListSerializer(ModelSerializer):
         """Metadata defined for the Django REST Framework."""
 
         model = AllowDenyList
-        fields = ('id', 'created_at', 'updated_at', 'type', 'allowed', 'content')
+        fields = ('id', 'created_at', 'updated_at', 'type', 'allowed', 'content', 'comment')
 
 
 class InfractionSerializer(ModelSerializer):
diff --git a/pydis_site/apps/api/viewsets/bot/allow_deny_list.py b/pydis_site/apps/api/viewsets/bot/allow_deny_list.py
index 2b9fd6a7..72cbc84c 100644
--- a/pydis_site/apps/api/viewsets/bot/allow_deny_list.py
+++ b/pydis_site/apps/api/viewsets/bot/allow_deny_list.py
@@ -24,6 +24,7 @@ class AllowDenyListViewSet(ModelViewSet):
     ...         'type': "file_format",
     ...         'allowed': 'true',
     ...         'content': ".jpeg",
+    ...         'comment': "Popular image format.",
     ...     },
     ...     ...
     ... ]
@@ -43,6 +44,7 @@ class AllowDenyListViewSet(ModelViewSet):
     ...     'type': "file_format",
     ...     'allowed': 'true',
     ...     'content': ".jpeg",
+    ...     'comment': "Popular image format.",
     ... }
 
     #### Status codes
@@ -57,6 +59,7 @@ class AllowDenyListViewSet(ModelViewSet):
     ...    'type': str,
     ...    'allowed': bool,
     ...    'content': str,
+    ...    'comment': Optional[str],
     ... }
 
     #### Status codes