encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-23 01:57:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
Fix introspection of list field in schema
This commit is contained in:
Carlton Gibson 2017-08-21 10:09:57 +02:00 committed by GitHub
commit d2286ba658
2 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
rest_framework/schemas.py
View File

@ -30,7 +30,7 @@ def field_to_schema(field):
title = force_text(field.label) if field.label else '' title = force_text(field.label) if field.label else ''
description = force_text(field.help_text) if field.help_text 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) child_schema = field_to_schema(field.child)
return coreschema.Array( return coreschema.Array(
items=child_schema, items=child_schema,

23
tests/test_schemas.py
View File

@ -39,6 +39,11 @@ class ExampleSerializer(serializers.Serializer):
hidden = serializers.HiddenField(default='hello') 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): class AnotherSerializer(serializers.Serializer):
c = serializers.CharField(required=True) c = serializers.CharField(required=True)
d = serializers.CharField(required=False) d = serializers.CharField(required=False)
@ -57,6 +62,13 @@ class ExampleViewSet(ModelViewSet):
""" """
return super(ExampleSerializer, self).retrieve(self, request) 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() @list_route()
def custom_list_action(self, request): def custom_list_action(self, request):
return super(ExampleViewSet, self).list(self, request) return super(ExampleViewSet, self).list(self, request)
@ -174,6 +186,17 @@ class TestRouterGeneratedSchema(TestCase):
coreapi.Field('d', required=False, location='form', schema=coreschema.String(title='D')), 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( 'custom_list_action': coreapi.Link(
url='/example/custom_list_action/', url='/example/custom_list_action/',
action='get' action='get'