Commit 19135061 by Tom Christie

Merge pull request #681 from dbrgn/format_suffixes_docs

Added function type detail to format suffix docs
parents d59ed649 bfdbc95f
...@@ -35,12 +35,22 @@ Example: ...@@ -35,12 +35,22 @@ Example:
urlpatterns = format_suffix_patterns(urlpatterns, allowed=['json', 'html']) urlpatterns = format_suffix_patterns(urlpatterns, allowed=['json', 'html'])
When using `format_suffix_patterns`, you must make sure to add the `'format'` keyword argument to the corresponding views. For example. When using `format_suffix_patterns`, you must make sure to add the `'format'` keyword argument to the corresponding view. For example:
@api_view(('GET',)) @api_view(('GET',))
def api_root(request, format=None): def api_root(request, format=None):
# do stuff... # do stuff...
Or with class based views:
class CommentList(APIView):
def get(self, request, format=None):
# do stuff...
def post(self, request, format=None):
# do stuff...
The name of the kwarg used may be modified by using the `FORMAT_SUFFIX_KWARG` setting. The name of the kwarg used may be modified by using the `FORMAT_SUFFIX_KWARG` setting.
Also note that `format_suffix_patterns` does not support descending into `include` URL patterns. Also note that `format_suffix_patterns` does not support descending into `include` URL patterns.
...@@ -58,4 +68,4 @@ It is actually a misconception. For example, take the following quote from Roy ...@@ -58,4 +68,4 @@ It is actually a misconception. For example, take the following quote from Roy
The quote does not mention Accept headers, but it does make it clear that format suffixes should be considered an acceptable pattern. The quote does not mention Accept headers, but it does make it clear that format suffixes should be considered an acceptable pattern.
[cite]: http://tech.groups.yahoo.com/group/rest-discuss/message/5857 [cite]: http://tech.groups.yahoo.com/group/rest-discuss/message/5857
[cite2]: http://tech.groups.yahoo.com/group/rest-discuss/message/14844 [cite2]: http://tech.groups.yahoo.com/group/rest-discuss/message/14844
\ No newline at end of file
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