Commit Graph

2274 Commits

Author SHA1 Message Date
Tom Christie
a9218e460f Minor tutorial updates 2016-07-14 12:44:13 +01:00
Tom Christie
aa40c58381 Note 'coreapi dump' command 2016-07-14 12:33:54 +01:00
Tom Christie
28820449f0 Merge branch 'master' of github.com:tomchristie/django-rest-framework 2016-07-14 12:29:46 +01:00
Tom Christie
5dd3d1b5d9 Update coreapi version in docs 2016-07-14 12:29:37 +01:00
Rashid Al Abri
df33035a3c Change incorrect example URL (#4261)
Changed http://example.com/api/items/4/.json to http://example.com/api/items/4.json
2016-07-14 12:28:28 +01:00
Tom Christie
06751f8548 Minor docs tweaks 2016-07-13 16:59:15 +01:00
Tom Christie
6f8a0f2a68 Update release docs 2016-07-13 16:46:50 +01:00
Tom Christie
e107c1dc35 Resize sponsor images 2016-07-13 16:33:27 +01:00
Tom Christie
8385ae42c0 3.4.0 Release (#4258)
* 3.4.0 Release

* Version 3.4 release

* Full release notes

* Update translation files

* Update release documentation

* Update release notes

* Docs on supporting alternate schema formats

* Add schema_renderers to DefaultRouter
2016-07-13 16:30:41 +01:00
Mads Jensen
6defb8da47 lookup_type is deprecated in favor of lookup_expr (#4259)
* lookup_type is deprecated in favor of lookup_expr
* assertEquals is deprecated in favor of assertEqual
* app_name is a required keyword as of Django 1.10
2016-07-13 14:40:42 +01:00
Tom Christie
f319e073e8 Client docs 2016-07-11 11:54:53 +01:00
Tom Christie
c21994e778 Merge branch 'master' of github.com:tomchristie/django-rest-framework 2016-07-08 16:38:47 +01:00
Tom Christie
c56d6d6bd3 Docs tweaks 2016-07-08 16:38:38 +01:00
Kenneth Schnall
ff5cfe3e84 Replace "class based views" occurrences with "class-based views" (#4251) 2016-07-08 08:38:50 +01:00
Tom Christie
7c171dfd83 Add tutorial 7 to homepage [ci skip] 2016-07-07 09:55:26 +01:00
Tom Christie
4a07d31d70 Add stream to premium backers [ci skip] (#4249) 2016-07-07 09:34:01 +01:00
kiyoqoko
6338ce80ab Add localize keyword argument to DecimalField (#4233)
Add `localize` keyword argument for DecimalField
2016-07-06 16:07:16 +01:00
Tom Christie
b10de37476 Funding text tweaks [ci skip] (#4247) 2016-07-05 15:58:36 +01:00
Tom Christie
6ff9840bde Schemas & client libraries. (#4179)
* Added schema generation support.
* New tutorial section.
* API guide on schema generation.
* Topic guide on API clients.
2016-07-04 16:38:17 +01:00
decore
1037a2742e Update pagination.md 2016-06-28 10:15:42 +08:00
Ken Lewerentz
57122f0422 Added missing colon in extra_kwargs documentation 2016-06-25 22:05:28 +07:00
Tom Christie
3a7bfdfa70 Add sentry as a premium sponsor [skip ci] (#4221)
Add Sentry as a premium sponsor.
2016-06-24 11:05:19 +01:00
Ankush Thakur
879652ec2e Update 2-requests-and-responses.md (#4209)
Make the usage of httpie accept headers more explicit.
2016-06-21 21:07:55 +01:00
Kenneth Love
498ce85f34 Update third-party-resources.md (#4200) 2016-06-15 21:17:16 +01:00
Tom Christie
c3b7fba918 Exclude read_only=True fields from unique_together validation & add docs. (#4192)
* Exclude read_only=True fields from unique_together validation
* Test to ensure that unique_together validators can be removed
* Do not add uniquness_extra_kwargs when validators are explicitly declared.
* Add docs on validation in complex cases
2016-06-13 13:31:12 +01:00
Tom Christie
b1035b2a87 Minor docs tweaks. [ci skip] (#4174) 2016-06-06 12:03:37 +01:00
Tom Christie
2712d4e5fe Note on obtain_auth_token and throttles/permissions. Closes #4128. [ci skip] (#4173) 2016-06-06 11:03:56 +01:00
Tom Christie
d404597e0b Update FileUploadParser docs. Closes #4167. [ci skip] (#4169) 2016-06-03 09:37:09 +01:00
Tom Christie
75751cc64e Allow relative style hyperlinked URLs 2016-06-02 15:03:17 +01:00
Tom Christie
53a356a380 Fix docs link [ci skip] (#4165) 2016-06-02 10:35:18 +01:00
sohopro
20e3a9a006 Update filtering.md 2016-06-02 16:12:35 +09:00
Adam Chainz
e3337ab4aa Convert readthedocs link for their .org -> .io migration for hosted projects
As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’:

> Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard.

Test Plan: Manually visited all the links I’ve modified.
2016-05-29 23:26:56 +01:00
Tom Christie
8e082770b0 Premium sponsor link 2016-05-28 10:55:38 +01:00
Tom Christie
9895de990d Fix signup URLs 2016-05-28 10:23:59 +01:00
Tom Christie
3a173547ad Funding announcement (#4147) 2016-05-26 11:48:15 +01:00
Carlton Gibson
9d87dbc016 Remove Py2/Py3 difference from Example (#4145)
`print` is available as a function on every supported version of Python (2.7+)
2016-05-25 14:38:44 +01:00
Tom Christie
9b56dda918 Update requests.md
Drop out-of-date paragraph on `request.content`
2016-05-18 08:38:18 +01:00
Joe Simpson
5cf7d4a90d Add LaTeX renderer to documentation (#4131) 2016-05-17 12:09:25 +01:00
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
1823662e1e Merge pull request #4044 from linovia/merge/3.3.x_to_master
Merge the changes in 3.3.x back to master.
2016-04-21 11:31:15 +02: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
Xavier Ordoquy
95418eb8ac Add the medium collection related to Django REST framework. (#4043) 2016-04-08 14:43:10 +01:00
Raphael Gyory
b870101581 Update third-party-resources.md 2016-04-06 17:00:26 +02:00
Raphael Gyory
f1a384b61b Add Django Rest Messaging in Third party packages 2016-04-06 16:58:15 +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
Tom Viner
3e5a1397d7 remove trailing slash from cramer cursor link 2016-03-24 20:37:38 +00:00
S. Andrew Sheppard
101c178b8c links to html-json-forms package 2016-03-24 11:55:19 -05:00
Xavier Ordoquy
0e8306341d Merge pull request #3936 from carltongibson/null-uuid-fk-take2
Fix None UUID ForeignKey serialization
2016-03-22 22:46:33 +01:00
Stephan Groß
0056703fe8 Fix code sample indention 2016-03-21 10:23:34 +00:00
Stephan Groß
3785281d4c Add missing paginator in docs 2016-03-21 10:07:47 +00:00
Stephan Groß
91e869750e Fix typo 2016-03-21 08:57:43 +00:00
Xavier Ordoquy
f0fc339278 Release date update. 2016-03-14 08:40:00 +01: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
ildoc
2e2abbc811 updated tutorial for django 1.9 2016-03-07 20:59:58 +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
Kin
b572cdb068 fix typo 2016-03-07 20:58:12 +01:00
Xavier Ordoquy
6ea9a41408 Add #3962 in the last minute fixes. 2016-03-07 20:39:34 +01:00
Xavier Ordoquy
173c2f1e53 Release date update. 2016-03-07 20:22:47 +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
Xavier Ordoquy
97cc83483f Merge remote-tracking branch 'reference/stable/3.3.x' into stable/3.3.3 2016-03-01 10:39:34 +01:00
Xavier Ordoquy
0324429107 Add #3968 to the release notes. 2016-03-01 10:39:13 +01:00
Rex Kerr
f3b4cb5951 Fixes incorrect references to URLPathVersioning 2016-03-01 10:36:05 +01:00
Liping Wang
239815887d remove comma
remove comma
2016-03-01 10:35:41 +01:00
Liping Wang
05204333a5 [FIX] "@api_view" calling error.
"@api_view" usage error.
2016-03-01 10:35:41 +01:00
Liping Wang
c3cea1499f remove comma
remove comma
2016-03-01 15:46:20 +08:00
Liping Wang
d372ccca02 [FIX] "@api_view" calling error.
"@api_view" usage error.
2016-02-29 19:51:33 +08:00
Rex Kerr
88320b8a61 Fixes incorrect references to URLPathVersioning 2016-02-27 12:41:56 -08:00
Xavier Ordoquy
24a2ec0501 Merge remote-tracking branch 'reference/stable/3.3.x' into stable/3.3.3 2016-02-27 00:36:23 +01:00
Taranjeet
a609e4e1ca Docs: Fix repetitive word in the tutorial 2016-02-27 00:28:15 +01:00
Luke Murphy
c03c6c6e78 fix typo in relations docs 2016-02-27 00:27:41 +01:00
Tom Christie
a15e46af88 Merge pull request #3965 from ildoc/master
updated tutorial for django 1.9
2016-02-25 21:37:27 +00:00
Taranjeet
3fd6db1445 Docs: Fix repetitive word in the tutorial 2016-02-26 00:02:45 +05:30
ildoc
35036aee15 updated tutorial for django 1.9 2016-02-25 14:27:57 +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
José Padilla
bec5f3db83 Merge pull request #3941 from wesgt/master
fix typo
2016-02-17 07:11:36 -04: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
Kin
96644bd6c1 fix typo 2016-02-16 23:08:45 -08:00
Carlton Gibson
20d1fdba69 Fix None UUID ForeignKey serialization 2016-02-16 09:29:48 +01:00
Carlton Gibson
296c567645 Drop EOL Django 1.7 2016-02-15 16:07:42 +01:00
Xavier Ordoquy
c8ca3a1c05 Release notes for 3.3.3 2016-02-11 07:14:45 +01:00
Christian Berendt
ff4d7c7e07 Use 'password123' as password for new users in the tutorial
Trying to create a new user on Django 1.9.x with the password 'password'
will fail with the error message 'This password is too common.'. Because
of that it is necessary to change the used password from 'password' to
'password123'.
2016-02-04 07:26:15 +01:00
Chirag Khatri
62551bc80f typo in tutorial part 1 2016-02-03 15:25:31 +05:30
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
Emmanouil Konstantinidis
ee2861887e Mention DRF Docs - Live API Endpoints 2016-01-23 23:08:19 +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
221d6979c6 Fix the request data source. 2016-01-18 18:54:00 +01:00
Xavier Ordoquy
0051492963 Merge remote-tracking branch 'shvechikov/master' into feature/3776 2016-01-18 18:51:53 +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
Tom Christie
1c5dfc9c8d Merge pull request #3821 from zwernberg/master
update copyright 2016
2016-01-11 16:25:11 +00:00
Zach Wernberg
04b2f021a6 update copyright 2016 2016-01-11 08:13:07 -06:00
Jerel Unruh
f71d8afdb0 Added documentation for the Third Party jsonapi.org package 2016-01-07 13:42:02 -06: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
craigglennie
2d7d3b79a0 Make code block consistent in serialization tutorial
All the other code blocks in the Serialization tutorial can be copied and pasted, but there is one that includes the >>> shell prompt characters. This commit removes those characters, and also makes the output consistent with other code blocks by making it a comment.
2016-01-02 13:15:25 -08: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
Leonid Shvechikov
ff0292a757 Fix update model example in html-and-forms.md 2015-12-27 17:14:33 +03: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
Emmanouil Konstantinidis
1925ec7d33 Both are highly recommended 2015-12-21 13:59:05 +00:00
Emmanouil Konstantinidis
4204557bc5 Remove title and hr 2015-12-21 13:55:11 +00:00
Emmanouil Konstantinidis
958290724c Rest is "REST" 2015-12-21 13:47:04 +00:00
Emmanouil Konstantinidis
a83cb1d2f3 Minor changes 2015-12-21 13:45:11 +00:00
Emmanouil Konstantinidis
1aedaafba4 Add DRF docs to the list 2015-12-21 13:40:23 +00:00
Atul Varma
66de876dee Update bootstrap version in browsable-api.md 2015-12-19 10:34:39 -05:00
Peter Baehr
44ae037e81 Move urls.py changes down and add necessary import
The previous location of editting urls.py did not allow migrations to be created and the default import needs to be modified
2015-12-15 21:17:52 -05: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
5224feded4 Update the release date. 2015-12-14 07:32:50 +01:00
Xavier Ordoquy
bf18c9f6e3 3.3.2 release notes. 2015-12-14 07:22:30 +01: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
knbk
e203967e09 Add app_name to rest_framework.urls.
This allows users in Django 1.9+ to include the authentication urls
without specifying the namespace, as in:

    urlpatterns = [
        ...
        url(r'^auth/', include('rest_framework.urls'))
    ]
2015-12-08 02:25:00 +01:00
Kirill Zaborsky
85db6a681b Fixed versioning regexp
booking list regexp was fixed in 8b97bb8f68 but single booking wasn't for some reason, and `v1v2/bookings/123/` shouldn't be allowed here
2015-12-07 10:59:57 +03:00
Tom Christie
832d6322a7 Merge pull request #3631 from syphar/paginat
allow setting a custom Django Paginator class
2015-11-30 20:58:32 +00:00
Tom Christie
bd8098e31f Fix template typo.
Closes #3682.
Thanks for the report!
2015-11-30 17:21:41 +00:00
Nik Nyby
e3f62e230c Add missing link to django-crispy-forms 2015-11-30 10:48:56 -05:00
Prashant Tiwari
8b97bb8f68 Fix for Incorrect regex in URLPathVersioning documentation #3638 2015-11-26 06:23:59 +00:00
Xavier Ordoquy
d0352ae6fc Merge pull request #3621 from linovia/feature/how_to_turn_pagination_off
Document how to turn pagination off
2015-11-25 12:57:25 +01:00
Daniel Hahler
e786e4c4a1 doc: clarify that crispy-forms needs to be in INSTALLED_APPS 2015-11-23 15:05:38 +01:00
Xavier Ordoquy
f3de2146ea Merge pull request #3650 from silviogutierrez/master
Documentation fix for list serializers.
2015-11-19 07:46:01 +01:00
Silvio J. Gutierrez
ece7973479 Updated comment. 2015-11-18 21:52:20 -05:00
Xavier Ordoquy
edc5a79b85 Merge pull request #3497 from Ins1ne/feature/3340
update docs about detail page link for AdminRenderer
2015-11-18 17:38:07 +01:00
Silvio J. Gutierrez
f7646627f1 Documentation fix for list serializers. 2015-11-17 19:09:49 -05:00
Will Dady
ca0841576f Removing references to get_paginate_by() as it no longer exists. 2015-11-17 15:00:00 +11:00
Denis Cornehl
3806af3d15 allow setting a custom Django Paginator in pagination.PageNumberPagination 2015-11-13 16:04:12 +01:00