encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-15 06:07:41 +03:00
Code Issues Packages Projects Releases Wiki Activity
8,705 Commits 18 Branches 132 Tags 105 MiB
da9288878b
Commit Graph

357 Commits

Author SHA1 Message Date
Kent Kawashima
d82b332a09 Changes ternary conditionals to be PEP308 compliant (#5827) 2018-02-14 14:06:09 +00:00
Ryan P Kilby
73203e6b59 Rework dynamic list/detail actions (#5705) 
* Merge list/detail route decorators into 'action'

* Merge dynamic routes, add 'detail' attribute

* Add 'ViewSet.get_extra_actions()'

* Refactor dynamic route checking & collection

* Refactor dynamic route generation

* Add 'ViewSet.detail' initkwarg

* Fixup schema test

* Add release notes for dynamic action changes

* Replace list/detail route decorators in tests

* Convert tabs to spaces in router docs

* Update docs

* Make 'detail' a required argument of 'action'

* Improve router docs
 2018-01-25 09:40:49 +01:00
Jon Dufresne
d3f3c3d9c1 Prefer https protocol for links in docs when available 2018-01-15 15:15:21 +01:00
Jon Dufresne
d5c34aa813 Remove unused links from docs (#5735) 
Each removed link has no inline use.
 2018-01-15 15:03:44 +01:00
guntanis
88c75ba808
Fixed "typo" in example. 
Fixing code "typo" in example.
In the original file, line 145 reads:
        url(r'^api-auth/', include('rest_framework.urls'),
It's missing the closing parenthesis.
 2017-12-28 02:01:01 -08:00
José Padilla
743fc247eb Update tutorial (#5622) 
* Use createsuperuser email and username flags

* Only remove db.sqlite3

* Remove global permission class

This interferes with Core API schema endpoint

* Add default pagination class

* Specify changes made in snippets/urls.py

* Auth urls were already set in tutorial/urls.py

* Specify changes made in snippets/urls.py

* Use the suggested admin username from quickstart

* Move global pagination setting away from quickstart section
 2017-11-27 11:34:17 +01:00
Jon Dufresne
ff556a91fd Remove references to unsupported Django versions in docs and code (#5602) 
Per the trove classifiers, DRF only supports Django versions 1.10+. Can
drop documentation, code comments, and workarounds for older Django
versions.
 2017-11-20 09:35:54 +01:00
Ed Morley
22565d9a65 Docs: Fix a few typos in the release notes and tutorial (#5483) 2017-10-06 15:46:42 +01:00
Shreyans Sheth
e6193cfd9e Added Response import in Code Snippet (#5468) 
Added `from rest_framework.response import Response` in the viewset code snippet example
 2017-10-02 09:04:55 +02:00
Xavier Ordoquy
89daaf6276 Add the project layout to the quickstart to have a milestone for the project creation. (#5434) 2017-09-20 12:05:04 +02:00
qwhex
9b829bec2d Update 2-requests-and-responses.md: consistency 
Made it consistent with Part I. Catched it when commiting the code into my local tutorial repo.
 2017-08-22 20:37:31 +02:00
Berker Peksag
52e0f3ae08 Fix indentation of code example in chapter 7 (#5329) 2017-08-14 13:04:52 +01:00
Jimmy Gitonga
6e7c9594fe Updating the Django version "runserver" output and enforcing code block styling 
CHANGED the Django version run server output to “1.11”
ADDED “```” to a code block on line 44 of
“/tutorial/7-schemas-and-client-libraries/“ to enforce code wrap.
Perhaps, we might need to do this to all code blocks. I would be happy
to do that.
 2017-04-28 18:08:54 +03:00
Tom Christie
33290170e8 Merge pull request #5060 from jpadilla/encode 
Update links after moving to encode org
 2017-04-07 17:20:51 +01:00
José Padilla
c1f31492ae
Update links after moving to encode org 2017-04-07 10:28:35 -04:00
minusf
471065ebc6 Update 7-schemas-and-client-libraries.md 2017-03-30 12:28:55 +02:00
Dark Goat
3cf01b7350 Update 7-schemas-and-client-libraries.md 
fix django url syntax.
 2017-03-16 19:37:48 +08:00
sol HYUN
eb8c658f33 ID must start from 1 again 
At the beginning of tutorial4, The database had been removed
 2017-03-16 06:34:30 +09:00
atkawa7
7f59ce1ec2 Directly using Django's JSONResponse in the Tutorial (#4935) 
* directly using Django's JSONResponse

* fixed JsonResponse typo

* added safe=False to JsonResponse

* removed unnecessary 'safe=False' in JsonResponse
 2017-03-03 14:04:41 +00:00
Mitchel Humpherys
d6c6df40c6 docs: tutorial: Minor grammar "fix" (#4801) 2017-01-10 09:04:07 +00:00
Viktor Petersson
eed8f5bb42 Fixes comment from @xordoquy. 2017-01-05 12:06:08 +00:00
Viktor Petersson
7ef6e96725 Fixes documentation. 
Django==1.8.17 chokes on this unless it’s just `snippets`.
 2017-01-05 11:14:57 +00:00
Raphael Pierzina
238783f2ed Change DEFAULT_PERMISSION_CLASSES to a list in quickstart.md (#4733) 2016-12-02 17:01:37 +00:00
Mads Jensen
8ac524915c added on_delete=models.CASCADE to models.ForeignKey in the documentation (#4614) 2016-10-22 16:37:23 +01:00
Tom Christie
d647d37a99 Fix Accept header in tutorial. Closes #4604. [ci skip] 2016-10-21 15:45:28 +01:00
Tom Christie
3f6004c5a9 Use pk for URL conf and views. (#4592) 2016-10-20 09:42:40 +01:00
Fa773N M0nK
d5e63d2d7f Reflect that '@detail_route' responds to GET only by default. (#4582) 2016-10-18 11:06:04 +01:00
Tom Christie
0dec36eb41 Version 3.5 (#4525) 
* Start test case

* Added 'requests' test client

* Address typos

* Graceful fallback if requests is not installed.

* Add cookie support

* Tests for auth and CSRF

* Py3 compat

* py3 compat

* py3 compat

* Add get_requests_client

* Added SchemaGenerator.should_include_link

* add settings for html cutoff on related fields

* Router doesn't work if prefix is blank, though project urls.py handles prefix

* Fix Django 1.10 to-many deprecation

* Add django.core.urlresolvers compatibility

* Update django-filter & django-guardian

* Check for empty router prefix; adjust URL accordingly

It's easiest to fix this issue after we have made the regex.  To try
to fix it before would require doing something different for List vs
Detail, which means we'd have to know which type of url we're
constructing before acting accordingly.

* Fix misc django deprecations

* Use TOC extension instead of header

* Fix deprecations for py3k

* Add py3k compatibility to is_simple_callable

* Add is_simple_callable tests

* Drop python 3.2 support (EOL, Dropped by Django)

* schema_renderers= should *set* the renderers, not append to them.

* API client (#4424)

* Fix release notes

* Add note about 'User account is disabled.' vs 'Unable to log in'

* Clean up schema generation (#4527)

* Handle multiple methods on custom action (#4529)

* RequestsClient, CoreAPIClient

* exclude_from_schema

* Added 'get_schema_view()' shortcut

* Added schema descriptions

* Better descriptions for schemas

* Add type annotation to schema generation

* Coerce schema 'pk' in path to actual field name

* Deprecations move into assertion errors

* Use get_schema_view in tests

* Updte CoreJSON media type

* Handle schema structure correctly when path prefixs exist. Closes #4401

* Add PendingDeprecation to Router schema generation.

* Added SCHEMA_COERCE_PATH_PK and SCHEMA_COERCE_METHOD_NAMES

* Renamed and documented 'get_schema_fields' interface.
 2016-10-10 13:03:46 +01:00
Xavier Ordoquy
bea243a0ca Fix coreapi param arguments. (#4274) 2016-07-18 15:56:36 +01:00
Tom Christie
a9218e460f Minor tutorial updates 2016-07-14 12:44:13 +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
Kenneth Schnall
ff5cfe3e84 Replace "class based views" occurrences with "class-based views" (#4251) 2016-07-08 08:38:50 +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
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
Tom Christie
b1035b2a87 Minor docs tweaks. [ci skip] (#4174) 2016-06-06 12:03:37 +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
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
Kin
96644bd6c1 fix typo 2016-02-16 23:08:45 -08: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
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
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
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
qqbuby
1aa16caffe append a space after the comment mark to remain consistent with the other parts of the tutorial 2015-09-13 20:24:22 +08:00
qqbuby
1a8f9d0a0f fix issue #3395 to correct the output text at line 184in docs/tutorial/1-serialization.md 2015-09-12 01:36:40 +08:00
potpath
bb95de13bf Update 6-viewsets-and-routers.md 2015-09-04 16:07:20 +07:00
ThaJay
76fedcc348 Update 2-requests-and-responses.md 
just a small error, the trailing slash in the url should be omitted when adding a .suffix
 2015-08-12 19:49:43 +02:00
Tom Christie
c8ad0cce19 Bump minimum Django version to 1.5 2015-07-30 15:43:39 +01:00
Tom Christie
a4e0f03050 Tweak quickstart to show newest users first in list view 2015-07-30 14:18:09 +01:00
José Padilla
7f7e6b33ff Update quickstart.md 
Closes #3171
 2015-07-19 21:47:09 -04:00
Leonardo Giordani
4f6eba3ce8 Removed import of unused django.forms.widgets 2015-07-16 16:25:01 +02:00
Mark Skipper
b743818430 Remove unused import from docs example 2015-07-01 20:39:05 +01:00
José Padilla
2b6726e703 Merge pull request #2842 from frnc/patch-1 
Update 5-relationships-and-hyperlinked-apis.md
 2015-04-26 12:13:57 -04:00
Valentin Hăloiu
e148637d6d Frontpage example no longer uses model attribute 2015-04-23 04:44:10 +03:00
frnc
601cbf18d4 Update 5-relationships-and-hyperlinked-apis.md 
Following  [@jpadilla](https://github.com/jpadilla)'s suggestion in issue [#2837](https://github.com/tomchristie/django-rest-framework/issues/2837), I am proposing a little addition in "Creating an endpoint for the root of our API" section in order to make it clear that the `user-list` and `snippet-list` names will be declared later in `snippets/urls.py`. Missing this clarification might lead a beginner (like me) to think that the names are somehow assigned by rest_framework under the hood and to try the code too early, getting stuck in the following errors.
 2015-04-20 17:56:04 +02:00
Oleg Marshev
b0dd1fffbf Fix typo. 2015-04-07 19:40:23 +03:00
Kyle P. Johnson
d655a423fb Add necessary imports to final urls.py example 2015-03-16 11:17:02 -04:00
Esmail
2484dbf4e1 Fix example of explicit format URL (for real). 
Do what I meant to do in #2670:

The link is displayed in the tutorial as "http://example.com/api/items/4.json" but the hyperlink itself and what the example code actually works with are (in my opinion, less pretty) URLs like "http://example.com/api/items/4/.json".
 2015-03-11 12:00:19 -04:00
Tom Christie
18cc0230bf Clean up pagination attributes 2015-03-04 15:51:00 +00:00
Tom Christie
fbb21caaaa Merge master 2015-02-09 20:43:50 +00:00
José Padilla
235b98e427 Merge pull request #2460 from mmarvick/master 
Small fixes to the tutorial
 2015-02-06 11:31:25 -04:00
Michael Marvick
5bf803b6ed Revert some of the changes made in 1-serialization.md 2015-02-05 19:42:36 -08:00
José Padilla
aaa1fcd5d1 Fixes #2493 2015-02-01 16:18:02 -04:00
Michael Marvick
73bd0d539f tutorial #5 incorrectly referenced 'settings.py' instead of 'tutorial/settings.py' 2015-01-25 23:47:01 -08:00
Michael Marvick
2a6937f381 tutorial #2 incorrectly showed /item.json instead of /item/.json for format suffixes 2015-01-25 23:46:27 -08:00
Michael Marvick
90c9968a70 tutorial #1 incorrectly showed string of json instead of ReturnDict type from 'serializer.data', and also has a third item in the second usage 2015-01-25 23:45:56 -08:00
Tom Christie
9ec08ce578 Merge master 2015-01-21 13:12:14 +00:00
Eric Theise
b0bc79ed4d correcting "it's" to "its" in Tutorial 1 2015-01-19 14:49:36 -08:00
Tom Christie
6065cdbd93 Merge master 2015-01-19 15:16:57 +00:00
Travis Swientek
8ccf5bcc0b Tweaked a few issues in the tutorial documentation. 2015-01-09 11:36:21 -08:00
Tom Christie
6168f60ba8 Merge branch 'master' into version-3.1 2015-01-05 11:02:28 +00:00
Rob Terhaar
336faf5a86 fix widget style formatting 2015-01-01 21:01:16 -05:00
Tom Christie
d109ae0a2e Merge pull request #2010 from tanwanirahul/master 
Ability to customize method names without creating a custom router
 2014-12-19 16:09:01 +00:00
Rahul
8f0fef4b75 Updated documentation on url_path per suggestions. 2014-12-19 21:22:10 +05:30
tanwanirahul
a8a3fedb5c Add url_path documention for detail_route decorator 2014-12-19 20:16:46 +05:30
Tom Christie
c8d88c8c8a Merge branch 'master' into version-3.1 2014-12-18 11:21:25 +00:00
Brent O'Connor
7e9aac98fe The pre_save method no longer works. This resolved issue #2306 2014-12-17 16:54:04 -06:00
Brent O'Connor
4f33cfe1a0 With httpie 0.8.0 the HTTP method has to come after the auth argument. 2014-12-17 14:38:01 -06:00
Tymur Maryokhin
eeb6e34064 Docs/tutorial import fixes. Refs #2296 2014-12-17 17:28:11 +01:00
Tom Christie
418108632c Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-12-17 16:23:20 +00:00
Tom Christie
90b8f9221e Use six.BytesIO in tutorial. Closes #2296. 2014-12-17 16:23:00 +00:00
Tom Christie
5f933f575e Merge pull request #2298 from epicserve/fix_typo 
Fixed a typo
 2014-12-17 16:20:22 +00:00
Brent O'Connor
530f7a21b3 Fixed a typo 2014-12-17 10:19:15 -06:00
Tom Christie
1ba822010d Highlight trailing '.' in command so it wont be missed. 2014-12-17 15:22:27 +00:00
Tom Christie
b6ee784240 Merge master 2014-12-15 12:18:55 +00:00
Jason Spafford
b951c74df2 Made docs consistent 2014-12-15 01:24:12 -08:00
Tom Christie
baaa356489 Merge master 2014-12-12 15:37:43 +00:00
Tom Christie
9b88b5db69 Field->ReadOnlyField in tutorial docs 2014-12-11 09:54:55 +00:00
Tom Christie
76956beab4 snippets relationship in tutorial should be read_only 2014-12-09 19:53:27 +00:00
Tom Christie
af3fe5a39f Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-12-08 16:38:29 +00:00
Tom Christie
4e9ebb5fe9 cd back to parent directory 2014-12-08 16:38:17 +00:00
Tom Christie
302ec59a5c Merge pull request #2165 from phalt/httpie-examples 
Use httpie for tutorials
 2014-12-08 15:51:19 +00:00
phalt
f3ebac061e one last tabs / spaces! 2014-12-08 15:47:49 +00:00
phalt
8e9408115d fixed indentations 2014-12-08 15:41:01 +00:00
Xavier Ordoquy
e4820d611b Fix the new Django default db name 
PrimaryKeyRelatedField now needs a queryset argument.
urls now don't use urlpatterns.
 2014-12-06 10:58:17 +01:00
Tom Christie
b7b0fd3e14 Added .validated_data usage. Closes #2214. 2014-12-05 12:48:12 +00:00
Tom Christie
1b8c06aefe Style tweaks in examples 2014-12-05 12:46:08 +00:00