Commit Graph

943 Commits

Author SHA1 Message Date
Petros Moisiadis
788603e153 Document allow_empty argument (#4117)
ListSerializer fields or serializers that are passed many=True may also take an allow_empty=False argument to disallow empty lists as valid input.

Information about this was part of the 3.2 release announcement, but had not been part of the API docs until now.
2016-05-13 15:55:31 +01:00
Graham R. Jeffries
dbbf79be64 minor docs indentation fix (#4101)
Fixes a minor indentation typo.
2016-05-06 11:58:58 +01:00
Miro Hrončok
ffdac0d936 TokenAuthentication: Allow custom keyword in the header (#4097)
This allows subclassing TokenAuthentication and setting custom keyword,
thus allowing the Authorization header to be for example:

    Bearer 956e252a-513c-48c5-92dd-bfddc364e812

It doesn't change the behavior of TokenAuthentication itself,
it simply allows to reuse the logic of TokenAuthentication without
the need of copy pasting the class and changing one hardcoded string.

Related: #4080
2016-05-04 10:53:34 +01:00
Taylor Edmiston
c355cdc585 Fix typo in permissions docs 2016-05-03 14:20:45 -04:00
Kyle Hornberg
399e1c1dcf Typo fix (#4094) 2016-05-03 15:53:55 +01:00
Xavier Ordoquy
a9bbb502cb Remove references to South as we don't need it any longer. (#4085)
* Remove references to South as we don't need it any longer.
* Add a note about auth_token including Django migrations.
2016-04-29 14:16:03 +01:00
Xavier Ordoquy
bff3bebdbe Merge remote-tracking branch 'reference/stable/3.3.x' into merge_test
# Conflicts:
#	docs/topics/release-notes.md
2016-04-08 15:46:17 +02:00
Anthony Lukach
3fdd6e1db5 Add .partial_update to ModelViewSet documentation
The ModelViewSet inherits from the UpdateModelMixin, which provides the `.partial_update` method. This should be reflected in the documentation.
2016-03-29 10:50:12 -06:00
S. Andrew Sheppard
101c178b8c links to html-json-forms package 2016-03-24 11:55:19 -05:00
Stephan Groß
0056703fe8 Fix code sample indention 2016-03-21 10:23:34 +00:00
aleontiev
3a3fd66852 documentation: add a reference to the dynamic-rest addons under the serializers guide 2016-03-11 12:43:17 -05:00
Xavier Ordoquy
c91229aaab PAGINATE_BY_PARAM and MAX_PAGINATE_BY removed in 3.3 2016-03-08 06:41:08 +01:00
Xavier Ordoquy
c90cf828ae PAGE_SIZE addition in 3.1 2016-03-08 06:40:33 +01:00
Xavier Ordoquy
180137300f PAGINATE_BY removed in 3.3 2016-03-08 06:39:58 +01:00
Xavier Ordoquy
a0aac166bc DEFAULT_PAGINATION_SERIALIZER_CLASS removed in 3.1 2016-03-08 06:39:08 +01:00
Xavier Ordoquy
9208619362 Those are now fully removed. 2016-03-08 06:38:03 +01:00
Xavier Ordoquy
cac1ecb250 paginate_by removed in 3.3 2016-03-08 06:37:46 +01:00
Krzysztof Szularz
cfd681dc73 Add /en to Heroku guidelines link 2016-03-07 21:01:04 +01:00
meoooh
0a2a01d05a fix typo
fix typo
2016-03-07 20:58:47 +01:00
Wes
0e1dcb7323 fix typo 2016-03-07 20:58:24 +01:00
Luke Murphy
ef8e7f168f add rest-framework-generic-relations link to docs 2016-03-07 19:37:30 +01:00
José Padilla
b3582cd36b Merge pull request #3973 from lwm/docs-generic-relations
add rest-framework-generic-relations link to docs
2016-03-01 13:54:44 -04:00
Luke Murphy
66e86dc483 add rest-framework-generic-relations link to docs 2016-03-01 18:44:17 +01:00
Krzysztof Szularz
2ddd30be90 Add /en to Heroku guidelines link 2016-03-01 14:52:07 +01:00
Rex Kerr
f3b4cb5951 Fixes incorrect references to URLPathVersioning 2016-03-01 10:36:05 +01:00
Rex Kerr
88320b8a61 Fixes incorrect references to URLPathVersioning 2016-02-27 12:41:56 -08:00
Luke Murphy
c03c6c6e78 fix typo in relations docs 2016-02-27 00:27:41 +01:00
Luke Murphy
f3c5802872 fix typo in relations docs 2016-02-24 14:22:24 +01:00
José Padilla
0b6f53eb98 Merge pull request #3943 from erickwilder/3937-accept-callable-as-initial-value
Closes #3937. Support callable as the value of `initial` for any `serializer.Field`
2016-02-19 10:41:23 -04:00
Erick Wilder
a32baeab0c Use datetime example for the Field.initial attribute
Just like regular Django fields, the example adopted uses a `datetiume.date.today` to
illustrate the functionality.
2016-02-19 09:53:50 +01:00
meoooh
5cda3a04dd fix typo
fix typo
2016-02-18 14:43:41 +09:00
Erick Wilder
908efd6656 #3937 Update docs for the Field.initial attribute.
Add an usage example on how to pass a callable to the `Field.initial` in the docs.
2016-02-17 11:01:09 +01:00
Wes
b773f03bd0 fix typo 2016-02-17 16:35:53 +08:00
Xavier Ordoquy
d738ad7ae6 Update to serialization results (closes #3881). 2016-01-27 22:23:20 +01:00
James Beith
34901a5ffa Fix syntax errors in docs example
- Add missing comma in kwargs
- Remove spaces around keyword / parameter equals
- Replace incorrect curly brace with parenthesis
2016-01-24 13:33:18 +00:00
José Padilla
99a61d72a7 Fix broken link format 2016-01-20 14:04:04 -04:00
Xavier Ordoquy
f1b28b4d63 Merge pull request #3605 from ryanhiebert/slug-related-field-queryset
RelatedField get_queryset and context
2016-01-20 18:17:29 +01:00
Krzysztof Szularz
2d40be5bd8 Update link to Heroku guidelines
They seem to have changed the structure of the document.
2016-01-20 16:28:30 +01:00
Xavier Ordoquy
6f8e0c3c07 Merge pull request #3289 from koliber/update-docs-serilaizers-multi-update
Added explicit id field in multi update example
2016-01-18 18:44:03 +01:00
Ramon Moraes
a37a8748cc Update permissions.md
Adding additional note about the behavior of set permission classes per view as suggest on #3834
2016-01-15 11:44:25 -03:00
Nicolas Delaby
717e27c866 Document how to tweak authtoken.admin.TokenAdmin
With focus on large user base, but can be extended.
2016-01-14 14:59:31 +01:00
m1kola
5fa8a31855 Typo fix in docs/api-guide/relations.md
`slug field` in code snippet was replaced to `slug_field`
2016-01-06 17:58:45 +03:00
Luis San Pablo
183f8fad44 Class formatting 2015-12-31 21:18:41 -06:00
Luis San Pablo
ef491685a0 Initial fixes #3636 and fixes #3637 2015-12-31 21:14:57 -06:00
Robert Romano
c8915c0716 Change tab to spaces 2015-12-23 12:58:14 -08:00
Robert Romano
5fc938cbd1 The Internet Engineering Task Force approved the new HTTP status code 451. Adding to status.py and docs appropriately. 2015-12-23 12:54:17 -08:00
Tyrel Souza
8c0d736f23 Also fix usecases to use cases 2015-12-15 10:28:23 -05:00
Tyrel Souza
ffc10edd7e Fix minor typo on Pagination documentation 2015-12-15 10:24:49 -05:00
Xavier Ordoquy
dcaff71217 Merge pull request #3728 from karthik-suresh/Fixes-Issue3727
Import parser added to docs in API guide
2015-12-12 22:19:13 +01:00
Karthik Suresh
82973cfa32 Import parser added to docs in API guide
Added missing import statements in code snippet of API guide.

Closes-Issue: #3727
2015-12-12 21:59:08 +05:30