Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
D
django-rest-framework
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
django-rest-framework
Commits
fd72a814
Commit
fd72a814
authored
Apr 12, 2017
by
Tom Christie
Committed by
GitHub
Apr 12, 2017
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #5073 from khakulov/patch-1
Clarify get_schema_fields signature
parents
853f3931
613aa61a
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
10 additions
and
4 deletions
+10
-4
docs/api-guide/filtering.md
+5
-2
docs/api-guide/pagination.md
+5
-2
No files found.
docs/api-guide/filtering.md
View file @
fd72a814
...
@@ -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
...
...
docs/api-guide/pagination.md
View file @
fd72a814
...
@@ -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.
---
---
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment