Commit Graph

2238 Commits

Author SHA1 Message Date
Tom Christie
48a2f084aa Minor docs tweak [ci skip] 2016-07-28 13:38:05 +01:00
Tom Christie
449ec1d724 Version 3.4.1 [ci skip] (#4326) 2016-07-28 13:34:35 +01:00
Tom Christie
e407dc7f01 Added root_renderers argument (#4323) 2016-07-28 12:50:51 +01:00
Tom Christie
306726d9e8 Improve datetime format docs (#4322) 2016-07-28 12:25:21 +01:00
Tom Christie
061e0ed084 Added url and schema_url arguments (#4321) 2016-07-28 12:08:34 +01:00
Tom Christie
351e0a4a99 Fix json indent parameter. Closes #4281 (#4313) 2016-07-27 11:49:01 +01:00
Tom Christie
19b415ec25 Improve pagination docs. Refs #4304 [ci skip] 2016-07-26 16:45:27 +01:00
Gustavo Pantuza
da2ff1bc4a Adding support for RFC 4918 status codes (#4291)
* Added HTTP status codes from RFC 4918

* Updated documentation about status codes

* Added reference to RFC 4918
2016-07-26 11:09:12 +01:00
Hendra
48465a667a Remove outdated resources (#4295)
Removed links to Youtube videos that are no longer available and updated a link to a tutorial that has moved.
2016-07-26 11:03:05 +01:00
Osvaldo Santana Neto
02a81d3362 Fix SwaggerRenderer implementation example 2016-07-19 14:15:49 -03:00
Marc Gibbons
d80b0eaead Update schema generator example (#4267)
1. The returns from the views needs to be a Response
2. I found that instantiating the generator at the module level caused an import error when starting Django, likely because it is executing before all the app load magic happened. Moving it into the view method solved this.
2016-07-18 16:04:23 +01:00
Xavier Ordoquy
bea243a0ca Fix coreapi param arguments. (#4274) 2016-07-18 15:56:36 +01:00
Germán Larraín
1a65f72f71 docs.settings: fix name of VERSION_PARAM 2016-07-15 14:34:27 -04:00
anoopmalav
faf6f226cd Fix Typo in index.md
Currently generating invalid URL at index page.
http://www.django-rest-framework.org/'api-guide/schemas.md'

Though it is correct in navigation.
2016-07-14 22:57:38 +05:30
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