Response schemas from serializers will optionally be paginated

[PaulWay]

At the moment, if a non-default response serializer is set via responses in swagger_auto_schema, it will not pick up any pagination schema that might apply from any paginator inspectors.

This patch will take any serializers provided in the responses section and apply a pagination schema to them if the view should be paged. This does not apply to the default serializer from get_default_responses because that is already converted into a schema.

Signed-off-by: Paul Wayper [email protected]

[nicholasgcoles]

@axnsan12 wondering if it is possible to merge this PR?

[nicholasgcoles]

@PaulWay do you have a workaround for this?

[PaulWay]

Yeah, unfortunately the workaround is to subclass the view inspector and copy the get_response_schemas method, using my version of the code.

@axnsan12 What's your take on this?

[sondrewb]

Yeah, unfortunately the workaround is to subclass the view inspector and copy the get_response_schemas method, using my version of the code.

@axnsan12 What's your take on this?

Could you please provide an example with code (the workaround) that works for this use-case? Thanks.

[kavdev]

@axnsan12 this would be very helpful to have (assuming it's fixed)

[kavdev]

Suggested change

	if self.should_page():
	if self.has_list_response():
	schema = openapi.Schema(type=openapi.TYPE_ARRAY, items=schema)
	if self.should_page():

This needs another step to work with current code.

[nicholasgcoles]

Any chance there is an update on this? Such a useful feature.

[PaulWay]

Sorry, have had this on the back burner - will update this soon!

[gabrieldev525]

Some update about this issue? What's missing to finish and release it?

[lopezvit]

This exact same changes need to be done as well to line 259, so it also work when you want to add a description to the method:

                    schema = self.serializer_to_schema(serializer)
                    if self.has_list_response():
                        schema = openapi.Schema(type=openapi.TYPE_ARRAY, items=schema)

                    if self.should_page():
                        schema = self.get_paginated_response(schema) or schema
                    response.schema = schema