Merge pull request #5326 from limdauto/limdauto-patch-1

Fix introspection of list field in schema
encode · Aug 21, 2017 · d2286ba · d2286ba
2 parents 4d5e846 + 56021f9
commit d2286ba
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/rest_framework/schemas.py b/rest_framework/schemas.py
@@ -30,7 +30,7 @@ def field_to_schema(field):
     title = force_text(field.label) if field.label else ''
     description = force_text(field.help_text) if field.help_text else ''
 
-    if isinstance(field, serializers.ListSerializer):
+    if isinstance(field, (serializers.ListSerializer, serializers.ListField)):
         child_schema = field_to_schema(field.child)
         return coreschema.Array(
             items=child_schema,

diff --git a/tests/test_schemas.py b/tests/test_schemas.py
@@ -39,6 +39,11 @@ class ExampleSerializer(serializers.Serializer):
     hidden = serializers.HiddenField(default='hello')
 
 
+class AnotherSerializerWithListFields(serializers.Serializer):
+    a = serializers.ListField(child=serializers.IntegerField())
+    b = serializers.ListSerializer(child=serializers.CharField())
+
+
 class AnotherSerializer(serializers.Serializer):
     c = serializers.CharField(required=True)
     d = serializers.CharField(required=False)
@@ -57,6 +62,13 @@ def custom_action(self, request, pk):
         """
         return super(ExampleSerializer, self).retrieve(self, request)
 
+    @detail_route(methods=['post'], serializer_class=AnotherSerializerWithListFields)
+    def custom_action_with_list_fields(self, request, pk):
+        """
+        A custom action using both list field and list serializer in the serializer.
+        """
+        return super(ExampleSerializer, self).retrieve(self, request)
+
     @list_route()
     def custom_list_action(self, request):
         return super(ExampleViewSet, self).list(self, request)
@@ -174,6 +186,17 @@ def test_authenticated_request(self):
                             coreapi.Field('d', required=False, location='form', schema=coreschema.String(title='D')),
                         ]
                     ),
+                    'custom_action_with_list_fields': coreapi.Link(
+                        url='/example/{id}/custom_action_with_list_fields/',
+                        action='post',
+                        encoding='application/json',
+                        description='A custom action using both list field and list serializer in the serializer.',
+                        fields=[
+                            coreapi.Field('id', required=True, location='path', schema=coreschema.String()),
+                            coreapi.Field('a', required=True, location='form', schema=coreschema.Array(title='A', items=coreschema.Integer())),
+                            coreapi.Field('b', required=True, location='form', schema=coreschema.Array(title='B', items=coreschema.String())),
+                        ]
+                    ),
                     'custom_list_action': coreapi.Link(
                         url='/example/custom_list_action/',
                         action='get'