encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-22 09:36:49 +03:00
Code Issues Packages Projects Releases Wiki Activity
f8c16441fa
django-rest-framework/rest_framework
History
Reupen Shah f8c16441fa Add support for pagination in OpenAPI response schemas (#6867) 
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 to `BasePagination`. This method is intended to mirror `get_paginated_response()` (which takes a `list` and wraps it in a `dict`). 

Hence, `get_paginated_response_schema()` takes an unpaginated response schema (of type `array`) and wraps that with a schema object of type `object` 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.
2019-09-03 15:25:44 +02:00
..
authtoken Version 3.10.1 (#6817) 2019-07-17 14:17:45 +01:00
locale Version 3.10 (#6802) 2019-07-15 12:31:09 +01:00
management Add --urlconf to the generateschema command (#6696) 2019-06-09 15:23:52 +02:00
schemas Add support for pagination in OpenAPI response schemas (#6867) 2019-09-03 15:25:44 +02:00
static/rest_framework Docs sidebar improvements (#5638) (#6589) 2019-07-08 13:05:13 +01:00
templates/rest_framework upgrade jQuery to latest version (#6728) 2019-07-01 13:16:21 +01:00
templatetags replace force_text with force_str 2019-08-07 21:05:24 +02:00
utils replace force_text with force_str 2019-08-07 21:05:24 +02:00
__init__.py Version 3.10.1 (#6817) 2019-07-17 14:17:45 +01:00
apps.py Make DEFAULT_PAGINATION_CLASS None by default. (#5170) 2017-09-25 15:36:30 +02:00
authentication.py Replace all usage ugettext functions with the non-u versions (#6634) 2019-05-01 07:49:54 +02:00
checks.py Clarify pagination system check (#5524) 2017-10-23 12:31:59 +02:00
compat.py Version 3.10.1 (#6817) 2019-07-17 14:17:45 +01:00
decorators.py Remove old documentation (#6765) 2019-06-28 16:03:00 -07:00
documentation.py Ability to specify urlconf in include_docs_urls added (#6824) 2019-07-23 12:06:03 +01:00
exceptions.py replace force_text with force_str 2019-08-07 21:05:24 +02:00
fields.py Avoided double call for remote url in FileField.to_representation. (#6841) 2019-08-06 12:31:46 +02:00
filters.py replace force_text with force_str 2019-08-07 21:05:24 +02:00
generics.py Dropped Python 2 compatibility. (#6615) 2019-04-30 17:53:44 +02:00
metadata.py replace force_text with force_str 2019-08-07 21:05:24 +02:00
mixins.py Dropped Python 2 compatibility. (#6615) 2019-04-30 17:53:44 +02:00
negotiation.py Dropped Python 2 compatibility. (#6615) 2019-04-30 17:53:44 +02:00
pagination.py Add support for pagination in OpenAPI response schemas (#6867) 2019-09-03 15:25:44 +02:00
parsers.py replace force_text with force_str 2019-08-07 21:05:24 +02:00
permissions.py Dropped Python 2 compatibility. (#6615) 2019-04-30 17:53:44 +02:00
relations.py Replace all usage ugettext functions with the non-u versions (#6634) 2019-05-01 07:49:54 +02:00
renderers.py Don't render extra actions when unauthenticated (#6775) 2019-07-04 14:54:16 +01:00
request.py Dropped Python 2 compatibility. (#6615) 2019-04-30 17:53:44 +02:00
response.py Remove unnecessary bytes() calls (#6626) 2019-05-30 15:05:27 -07:00
reverse.py Dropped Python 2 compatibility. (#6615) 2019-04-30 17:53:44 +02:00
routers.py Remove 3.10 deprecations (#6687) 2019-05-21 10:36:55 -07:00
serializers.py Fix typos (#6835) 2019-07-25 10:04:01 -07:00
settings.py Update default settings to use lists instead of tuples (#6799) 2019-07-15 11:54:46 +01:00
status.py Add Multiple HTTP Statuses (#6706) 2019-05-30 14:32:46 -07:00
test.py Remove unnecessary bytes() calls (#6626) 2019-05-30 15:05:27 -07:00
throttling.py Dropped Python 2 compatibility. (#6615) 2019-04-30 17:53:44 +02:00
urlpatterns.py Dropped Python 2 compatibility. (#6615) 2019-04-30 17:53:44 +02:00
urls.py Dropped Python 2 compatibility. (#6615) 2019-04-30 17:53:44 +02:00
validators.py Replace all usage ugettext functions with the non-u versions (#6634) 2019-05-01 07:49:54 +02:00
versioning.py Replace all usage ugettext functions with the non-u versions (#6634) 2019-05-01 07:49:54 +02:00
views.py Handle 'None' return value of wait() properly during throttling. (#6837) 2019-08-12 11:36:05 -07:00
viewsets.py Fix typos (#6835) 2019-07-25 10:04:01 -07:00