Add support for pagination in OpenAPI response schemas #6867
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Refs #6846
This provides a way for pagination classes to add pagination properties (
count
,next
,results
etc.) to OpenAPI response schemas.A new method
get_paginated_response_schema()
has been added toBasePagination
. This method is intended to mirrorget_paginated_response()
(which takes alist
and typically wraps it in adict
).Hence,
get_paginated_response_schema()
takes an unpaginated response schema (of typearray
) and wraps that with a schema object of typeobject
containing the relevant properties that the pagination class adds to responses.The default implementation of
BasePagination.get_paginated_response_schema()
simply passes the schema through unmodified, for backwards compatibility.