From 0576b70f921e7bdf9d950ecb8c4202200a61d5f9 Mon Sep 17 00:00:00 2001 From: Sebastiaan Zeeff <33516116+SebastiaanZ@users.noreply.github.com> Date: Tue, 17 Sep 2019 16:24:10 +0200 Subject: Make API return infraction list with newest first The most recent infraction a user has is usually the most relevant to us. This PR aims to make our life easier by sorting the infractions by their `inserted_at` date, with the most recent insertion date first. Note: The `id` is not entirely in chronological order, because we did not import historical infractions in chronological order. That's why the `inserted_at` field is specified instead of the `id` field. --- .../migrations/0042_infraction_add_default_ordering.py | 17 +++++++++++++++++ pydis_site/apps/api/models/bot/infraction.py | 5 +++++ pydis_site/apps/api/tests/test_infractions.py | 5 +++-- 3 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 pydis_site/apps/api/migrations/0042_infraction_add_default_ordering.py diff --git a/pydis_site/apps/api/migrations/0042_infraction_add_default_ordering.py b/pydis_site/apps/api/migrations/0042_infraction_add_default_ordering.py new file mode 100644 index 00000000..1a0dbb34 --- /dev/null +++ b/pydis_site/apps/api/migrations/0042_infraction_add_default_ordering.py @@ -0,0 +1,17 @@ +# Generated by Django 2.2.3 on 2019-09-17 14:07 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ('api', '0041_add_default_ordering_deleted_messages'), + ] + + operations = [ + migrations.AlterModelOptions( + name='infraction', + options={'ordering': ['-inserted_at']}, + ), + ] diff --git a/pydis_site/apps/api/models/bot/infraction.py b/pydis_site/apps/api/models/bot/infraction.py index da91d6c2..dfb32a97 100644 --- a/pydis_site/apps/api/models/bot/infraction.py +++ b/pydis_site/apps/api/models/bot/infraction.py @@ -66,3 +66,8 @@ class Infraction(ModelReprMixin, models.Model): if self.hidden: s += " (hidden)" return s + + class Meta: + """Defines the meta options for the infraction model.""" + + ordering = ['-inserted_at'] diff --git a/pydis_site/apps/api/tests/test_infractions.py b/pydis_site/apps/api/tests/test_infractions.py index 7c370c17..0092d355 100644 --- a/pydis_site/apps/api/tests/test_infractions.py +++ b/pydis_site/apps/api/tests/test_infractions.py @@ -63,6 +63,7 @@ class InfractionTests(APISubdomainTestCase): ) def test_list_all(self): + """Tests the list-view, which should be ordered by inserted_at (newest first).""" url = reverse('bot:infraction-list', host='api') response = self.client.get(url) @@ -70,8 +71,8 @@ class InfractionTests(APISubdomainTestCase): infractions = response.json() self.assertEqual(len(infractions), 2) - self.assertEqual(infractions[0]['id'], self.ban_hidden.id) - self.assertEqual(infractions[1]['id'], self.ban_inactive.id) + self.assertEqual(infractions[0]['id'], self.ban_inactive.id) + self.assertEqual(infractions[1]['id'], self.ban_hidden.id) def test_filter_search(self): url = reverse('bot:infraction-list', host='api') -- cgit v1.2.3