Merge pull request #265 from Georiviere/fix_not_required_empty_strings

Allow send empty string on not required in custom contribution API
Georiviere · Jul 2, 2024 · 8a051d0 · 8a051d0
2 parents f55ecad + 83a00c9
commit 8a051d0
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 5 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -5,6 +5,9 @@ CHANGELOG
 1.4.1+dev (XXXX-XX-XX)
 ----------------------
 
+**Bug fix**
+
+- Allow send empty string on not required in custom contribution API
 
 
 1.4.1    (2024-07-02)

diff --git a/georiviere/portal/serializers/contribution.py b/georiviere/portal/serializers/contribution.py
@@ -237,9 +237,13 @@ def __init__(self, *args, **kwargs):
                 output_field = serializers.DateField
             elif field.get("type") == "string" and field.get("format") == "date-time":
                 output_field = serializers.DateTimeField
+            required = key in schema.get("required", [])
             # make field required or not
+            kwargs = {"label": field.get("title"), "required": required}
+            if output_field == serializers.CharField:
+                kwargs["allow_blank"] = not required
             self.fields[key] = output_field(
-                label=field.get("title"), required=key in schema.get("required", [])
+                **kwargs
             )
 
         # station is required if defined at custom_type level. Geom is not required because replace by station geom

diff --git a/georiviere/portal/tests/test_views/test_contribution.py b/georiviere/portal/tests/test_views/test_contribution.py
@@ -327,10 +327,14 @@ def setUpTestData(cls):
         cls.station = StationFactory()
         cls.custom_contribution_type = CustomContributionTypeFactory()
         cls.custom_contribution_type.stations.add(cls.station)
-        CustomContributionTypeStringFieldFactory(
+        cls.string_field = CustomContributionTypeStringFieldFactory(
             custom_type=cls.custom_contribution_type,
             label="Field string",
         )
+        cls.string_field_blank = CustomContributionTypeStringFieldFactory(
+            custom_type=cls.custom_contribution_type,
+            label="Field string empty",
+        )
         CustomContributionTypeBooleanFieldFactory(
             custom_type=cls.custom_contribution_type,
             label="Field boolean",
@@ -376,11 +380,12 @@ def test_create(self):
         data = response.json()
         self.assertEqual(response.status_code, 201, data)
 
-    def test_null_values_on_not_required(self):
-        """Null values should be accepted on non required fields"""
+    def test_no_values_on_not_required(self):
+        """Null and empty values should be accepted on non required fields"""
         data = {
             "station": self.station.pk,
-            "field_string": "string",
+            self.string_field.key: None,
+            self.string_field_blank.key: "",
             "field_boolean": None,
             "field_float": 1.1,
             "contributed_at": "2020-01-01T00:00"