Partial serializer should not have required fields (OpenAPI)

[denisorehovsky]

No description provided.

[adamchainz]

Plaese provide more explanation of this issue - e.g. a link to the relevant decsription in the Open API spec, what issues you're facing, ...

[denisorehovsky]

@adamchainz Hi, Adam. Here's the problem. Let's say we have this serializer:

class ExampleSerializer(serializers.Serializer):
    field_a = serializers.CharField()
    field_b = serializers.CharField()

And a ViewSet:

class ExampleViewSet:
    serializer_class = ExampleSerializer

    def partial_update(self, ...):
        pass

Since the request is partial, all the fields are not required. In a request body, we can send:

• Only field_a
• Only field_b
• Both field_a and field_b

And it should work. However, DRF's OpenAPI generated documentation will show that both field_a and field_b are required, even though they're not.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[denisorehovsky]

@adamchainz So what do you think?

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[auvipy]

it is a very small change so if you could rebase we can consider accepting this. otherwise will close

[auvipy]

can you please share the relevant part of the spec to verify?

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.