Add description field to datasets (#33)

Author: willemarcel

vbos/datasets/migrations/0015_rasterdataset_description_tabulardataset_description_and_more.py

@@ -0,0 +1,31 @@
+# Generated by Django 5.2.5 on 2025-10-17 16:39
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        (
+            "datasets",
+            "0014_alter_rasterdataset_type_alter_tabulardataset_type_and_more",
+        ),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="rasterdataset",
+            name="description",
+            field=models.TextField(blank=True, max_length=2000, null=True),
+        ),
+        migrations.AddField(
+            model_name="tabulardataset",
+            name="description",
+            field=models.TextField(blank=True, max_length=2000, null=True),
+        ),
+        migrations.AddField(
+            model_name="vectordataset",
+            name="description",
+            field=models.TextField(blank=True, max_length=2000, null=True),
+        ),
+    ]

vbos/datasets/models.py

@@ -82,6 +82,7 @@ def delete_raster_file(sender, instance, **kwargs):
 
 class RasterDataset(models.Model):
     name = models.CharField(max_length=155)
+    description = models.TextField(max_length=2000, null=True, blank=True)
     created = models.DateTimeField(auto_now_add=True)
     updated = models.DateTimeField(auto_now=True)
     cluster = models.ForeignKey(
@@ -102,6 +103,7 @@ class Meta:
 
 class VectorDataset(models.Model):
     name = models.CharField(max_length=155, unique=False)
+    description = models.TextField(max_length=2000, null=True, blank=True)
     created = models.DateTimeField(auto_now_add=True)
     updated = models.DateTimeField(auto_now=True)
     cluster = models.ForeignKey(
@@ -141,6 +143,7 @@ class Meta:
 
 class TabularDataset(models.Model):
     name = models.CharField(max_length=155, unique=False)
+    description = models.TextField(max_length=2000, null=True, blank=True)
     created = models.DateTimeField(auto_now_add=True)
     updated = models.DateTimeField(auto_now=True)
     cluster = models.ForeignKey(

vbos/datasets/serializers.py

@@ -44,6 +44,7 @@ class Meta:
         fields = [
             "id",
             "name",
+            "description",
             "created",
             "updated",
             "cluster",
@@ -58,7 +59,16 @@ class VectorDatasetSerializer(serializers.ModelSerializer):
 
     class Meta:
         model = VectorDataset
-        fields = ["id", "name", "created", "updated", "cluster", "type", "source"]
+        fields = [
+            "id",
+            "name",
+            "description",
+            "created",
+            "updated",
+            "cluster",
+            "type",
+            "source",
+        ]
 
 
 class VectorItemSerializer(GeoFeatureModelSerializer):
@@ -91,6 +101,7 @@ class Meta:
         fields = [
             "id",
             "name",
+            "description",
             "created",
             "updated",
             "cluster",

vbos/datasets/test/test_raster_views.py

@@ -15,6 +15,7 @@ def setUp(self):
         )
         self.dataset_1 = RasterDataset.objects.create(
             name="Rainfall",
+            description="Rainfall data since 2020",
             cluster=Cluster.objects.create(name="Environment"),
             file=self.r_1,
             source="WMO",
@@ -34,6 +35,7 @@ def test_raster_datasets_list(self):
         assert req.data.get("count") == 2
         assert req.data.get("results")[0]["name"] == "Rainfall"
         assert req.data.get("results")[1]["name"] == "Coastline changes"
+        assert req.data.get("results")[0]["description"] == "Rainfall data since 2020"
         assert req.data.get("results")[0]["cluster"] == "Environment"
         assert req.data.get("results")[1]["cluster"] == "Administrative"
         assert req.data.get("results")[0]["source"] == "WMO"
@@ -67,6 +69,7 @@ def test_raster_datasets_detail(self):
         assert req.data.get("updated")
         assert req.data.get("source") == "WMO"
         assert req.data.get("cluster") == "Environment"
+        assert req.data.get("description") == "Rainfall data since 2020"
 
     def tearDown(self):
         RasterDataset.objects.all().delete()

vbos/datasets/test/test_tabular_views.py

@@ -14,6 +14,7 @@ def setUp(self):
             name="Population",
             cluster=Cluster.objects.create(name="Administrative"),
             source="Government",
+            description="Population statistics since 2020",
         )
         self.dataset_2 = TabularDataset.objects.create(
             name="Prices",
@@ -36,6 +37,10 @@ def test_tabular_datasets_list(self):
         assert req.data.get("results")[1]["cluster"] == "Statistics"
         assert req.data.get("results")[0]["type"] == "baseline"
         assert req.data.get("results")[1]["type"] == "estimated_damage"
+        assert (
+            req.data.get("results")[0]["description"]
+            == "Population statistics since 2020"
+        )
         assert req.data.get("results")[1]["unit"] == "Vatu (VUV)"
 
     def test_raster_datasets_list_filter(self):

vbos/datasets/test/test_vector_views.py

@@ -13,6 +13,7 @@ def setUp(self):
             name="Boundaries",
             cluster=Cluster.objects.create(name="Administrative"),
             source="OSM",
+            description="Administratives Boundaries",
         )
         self.dataset_2 = VectorDataset.objects.create(
             name="Roads",
@@ -27,6 +28,7 @@ def test_vector_datasets_list(self):
         assert req.data.get("count") == 2
         assert req.data.get("results")[0]["name"] == "Boundaries"
         assert req.data.get("results")[1]["name"] == "Roads"
+        assert req.data.get("results")[0]["description"] == "Administratives Boundaries"
         assert req.data.get("results")[0]["type"] == "baseline"
         assert req.data.get("results")[1]["type"] == "estimated_damage"
 
@@ -44,6 +46,7 @@ def test_vector_datasets_detail(self):
         req = self.client.get(url)
         assert req.status_code == status.HTTP_200_OK
         assert req.data.get("name") == "Boundaries"
+        assert req.data.get("description") == "Administratives Boundaries"
         assert req.data.get("created")
         assert req.data.get("updated")
         assert req.data.get("cluster") == "Administrative"