Merge pull request #107 from ziotom78/empty_metadata

Allow empty metadata in data files

CHANGELOG.md

@@ -1,5 +1,7 @@
 # HEAD
 
+-   Allow empty metadata in data files when using the RESTful API [#107](https://github.com/ziotom78/instrumentdb/pull/107)
+
 -   Implement Swagger and Redoc web pages documenting the RESTful API [#106](https://github.com/ziotom78/instrumentdb/pull/106)
 
 -   Validate entity/quantity names in forms and RESTful API [#102](https://github.com/ziotom78/instrumentdb/pull/102), [#105](https://github.com/ziotom78/instrumentdb/pull/105)

browse/migrations/0007_alter_datafile_metadata.py

@@ -0,0 +1,25 @@
+# Generated by Django 4.2.4 on 2023-08-11 13:46
+
+import browse.models
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("browse", "0006_alter_entity_name_alter_quantity_name"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="datafile",
+            name="metadata",
+            field=models.TextField(
+                blank=True,
+                help_text="JSON record containing metadata for the file",
+                max_length=32768,
+                null=True,
+                validators=[browse.models.validate_json],
+                verbose_name="JSON-formatted metadata",
+            ),
+        ),
+    ]

browse/models.py

@@ -175,6 +175,9 @@
 def validate_json(value):
     """Check that `value` is a valid JSON record"""
 
+    if value is None or value == "":
+        return
+
     try:
         json.loads(value)
     except json.JSONDecodeError as err:
@@ -364,6 +367,7 @@ class DataFile(models.Model):
         "JSON-formatted metadata",
         max_length=32768,
         blank=True,
+        null=True,
         help_text="JSON record containing metadata for the file",
         validators=[validate_json],
     )

browse/serializers.py

@@ -144,7 +144,7 @@ class DataFileSerializer(serializers.HyperlinkedModelSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name="datafile-detail", read_only=True
     )
-    metadata = JSONField(validators=[serializer_validate_json])
+    metadata = JSONField(required=False, validators=[serializer_validate_json])
 
     class Meta:
         model = DataFile