Skip to content

Commit

Permalink
Partial serializer should not have required fields (#7563)
Browse files Browse the repository at this point in the history
  • Loading branch information
denisorehovsky authored Aug 13, 2023
1 parent 7a9db57 commit da92888
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 1 deletion.
2 changes: 1 addition & 1 deletion rest_framework/schemas/openapi.py
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ def map_serializer(self, serializer):
if isinstance(field, serializers.HiddenField):
continue

if field.required:
if field.required and not serializer.partial:
required.append(self.get_field_name(field))

schema = self.map_field(field)
Expand Down
50 changes: 50 additions & 0 deletions tests/schemas/test_openapi.py
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,56 @@ class View(generics.GenericAPIView):
assert list(schema['properties']['nested']['properties'].keys()) == ['number']
assert schema['properties']['nested']['required'] == ['number']

def test_response_body_partial_serializer(self):
path = '/'
method = 'GET'

class ItemSerializer(serializers.Serializer):
text = serializers.CharField()

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.partial = True

class View(generics.GenericAPIView):
serializer_class = ItemSerializer

view = create_view(
View,
method,
create_request(path),
)
inspector = AutoSchema()
inspector.view = view

responses = inspector.get_responses(path, method)
assert responses == {
'200': {
'description': '',
'content': {
'application/json': {
'schema': {
'type': 'array',
'items': {
'$ref': '#/components/schemas/Item'
},
},
},
},
},
}
components = inspector.get_components(path, method)
assert components == {
'Item': {
'type': 'object',
'properties': {
'text': {
'type': 'string',
},
},
}
}

def test_list_response_body_generation(self):
"""Test that an array schema is returned for list views."""
path = '/'
Expand Down

0 comments on commit da92888

Please sign in to comment.