Commit fd72a814 by Tom Christie Committed by GitHub

Merge pull request #5073 from khakulov/patch-1

Clarify get_schema_fields signature
parents 853f3931 613aa61a
...@@ -432,8 +432,11 @@ The method should return a rendered HTML string. ...@@ -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
......
...@@ -279,8 +279,11 @@ API responses for list endpoints will now include a `Link` header, instead of in ...@@ -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.
--- ---
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment