Correct schema parsing for JSONField (encode#5878)

beruic · Pierre Chiquet · commit ea2521923047 · 2020-03-24T09:46:35.000+01:00
Fixes encode#5873. * Use Object type. * Add test for field_to_schema
diff --git a/rest_framework/schemas/inspectors.py b/rest_framework/schemas/inspectors.py
@@ -95,13 +95,16 @@ def field_to_schema(field):
             description=description,
             format='date-time'
         )
+    elif isinstance(field, serializers.JSONField):
+        return coreschema.Object(title=title, description=description)
 
     if field.style.get('base_template') == 'textarea.html':
         return coreschema.String(
             title=title,
             description=description,
             format='textarea'
         )
+
     return coreschema.String(title=title, description=description)
 
 
diff --git a/tests/test_schemas.py b/tests/test_schemas.py
@@ -17,6 +17,7 @@
     AutoSchema, ManualSchema, SchemaGenerator, get_schema_view
 )
 from rest_framework.schemas.generators import EndpointEnumerator
+from rest_framework.schemas.inspectors import field_to_schema
 from rest_framework.schemas.utils import is_list_view
 from rest_framework.test import APIClient, APIRequestFactory
 from rest_framework.utils import formatting
@@ -763,6 +764,46 @@ class CustomView(APIView):
         link = view.schema.get_link(path, method, base_url)
         assert link == expected
 
+    def test_field_to_schema(self):
+        label = 'Test label'
+        help_text = 'This is a helpful test text'
+
+        cases = [
+            # tuples are ([field], [expected schema])
+            # TODO: Add remaining cases
+            (
+                serializers.BooleanField(label=label, help_text=help_text),
+                coreschema.Boolean(title=label, description=help_text)
+            ),
+            (
+                serializers.DecimalField(1000, 1000, label=label, help_text=help_text),
+                coreschema.Number(title=label, description=help_text)
+            ),
+            (
+                serializers.FloatField(label=label, help_text=help_text),
+                coreschema.Number(title=label, description=help_text)
+            ),
+            (
+                serializers.IntegerField(label=label, help_text=help_text),
+                coreschema.Integer(title=label, description=help_text)
+            ),
+            (
+                serializers.DateField(label=label, help_text=help_text),
+                coreschema.String(title=label, description=help_text, format='date')
+            ),
+            (
+                serializers.DateTimeField(label=label, help_text=help_text),
+                coreschema.String(title=label, description=help_text, format='date-time')
+            ),
+            (
+                serializers.JSONField(label=label, help_text=help_text),
+                coreschema.Object(title=label, description=help_text)
+            ),
+        ]
+
+        for case in cases:
+            self.assertEqual(field_to_schema(case[0]), case[1])
+
 
 def test_docstring_is_not_stripped_by_get_description():
     class ExampleDocstringAPIView(APIView):

Original file line number	Diff line number	Diff line change
`@@ -95,13 +95,16 @@ def field_to_schema(field):`
`95`	`95`	`description=description,`
`96`	`96`	`format='date-time'`
`97`	`97`	`)`
	`98`	`+ elif isinstance(field, serializers.JSONField):`
	`99`	`+ return coreschema.Object(title=title, description=description)`
`98`	`100`
`99`	`101`	`if field.style.get('base_template') == 'textarea.html':`
`100`	`102`	`return coreschema.String(`
`101`	`103`	`title=title,`
`102`	`104`	`description=description,`
`103`	`105`	`format='textarea'`
`104`	`106`	`)`
	`107`	`+`
`105`	`108`	`return coreschema.String(title=title, description=description)`
`106`	`109`
`107`	`110`