Merge pull request #356 from peopledoc/form-filler-extra-fields

fields parameters are not the write-only anymore

Author: alexdashkov

CHANGELOG.rst

@@ -12,6 +12,7 @@ master (unreleased)
 - Change the global exception handling error level, from "error" to "exception". It'll provide better insights if you're using Logmatic or any other logging aggregator (#336).
 - Skip `tox` installation in the circle-ci environment: it's already there (#344).
 - Refactoring of the field builder (Use only one module for the form builder factory) (#347).
+- Add `parameters` to the fields schema
 
 Release 2.1.2 (2018-08-29)
 ==========================

demo/requirements-demo.pip

@@ -6,3 +6,5 @@ django-perf-rec
 mock
 # added a typing module to fix https://github.com/django-extensions/django-extensions/issues/1176
 typing
+# A temporary workaround for DRF-related error:
+Markdown~=2.6

demo/tests/serializers/test_formidable_serializer.py

@@ -78,7 +78,7 @@ def test_custom_field_serialize(self):
         # test serialized data
         self.assertIn('meta_info', data)
         self.assertIn('some_another_data', data)
-        self.assertNotIn('parameters', data)
+        self.assertIn('parameters', data)
         # remove instance
         self.instance.delete()
 

formidable/serializers/fields.py

@@ -114,7 +114,7 @@ class FieldSerializer(WithNestedSerializer):
     # redefine here the order field just to take it at the save/update time
     # The order is automatically calculated, if the order is define in
     # incoming payload, it will be automatically overridden.
-    parameters = serializers.JSONField(write_only=True)
+    parameters = serializers.JSONField()
     order = serializers.IntegerField(write_only=True, required=False)
     defaults = DefaultSerializer(many=True, required=False)
     description = serializers.CharField(required=False, allow_null=True,
@@ -126,7 +126,9 @@ def to_internal_value(self, data):
         if 'help_text' in data:
             data['description'] = data.pop('help_text')
 
-        data['parameters'] = {}
+        if not data.get('parameters'):
+            data['parameters'] = {}
+
         for config_field in self.get_config_fields():
             data['parameters'][config_field] = data.pop(config_field, None)
 
@@ -137,7 +139,6 @@ def to_representation(self, instance):
         for config_field in self.get_config_fields():
             if instance.parameters is not None:
                 field[config_field] = instance.parameters.get(config_field)
-        field.pop('parameters', None)
         return field
 
     def get_config_fields(self):