encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-02-09 16:10:50 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5073 from khakulov/patch-1

Browse Source 
Clarify get_schema_fields signature
This commit is contained in:
Tom Christie 2017-04-12 17:22:33 +01:00 committed by GitHub
commit fd72a814f8
2 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/api-guide/filtering.md
View File

@ -432,8 +432,11 @@ The method should return a rendered HTML string.
## Pagination & schemas ## Pagination & schemas
You can also make the filter controls available to the schema autogeneration You can also make the filter controls available to the schema autogeneration
that REST framework provides, by implementing a `get_schema_fields()` method, that REST framework provides, by implementing a `get_schema_fields()` method. This method should have the following signature:
which should return a list of `coreapi.Field` instances.
`get_schema_fields(self, view)`
The method should return a list of `coreapi.Field` instances.
# Third party packages # Third party packages

7
docs/api-guide/pagination.md
View File

@ -279,8 +279,11 @@ API responses for list endpoints will now include a `Link` header, instead of in
## Pagination & schemas ## Pagination & schemas
You can also make the pagination controls available to the schema autogeneration You can also make the pagination controls available to the schema autogeneration
that REST framework provides, by implementing a `get_schema_fields()` method, that REST framework provides, by implementing a `get_schema_fields()` method. This method should have the following signature:
which should return a list of `coreapi.Field` instances.
`get_schema_fields(self, view)`
The method should return a list of `coreapi.Field` instances.
--- ---