Commit Graph

2501 Commits

Author SHA1 Message Date
Carlton Gibson
2befa6c316 Document documentation.py (#5478)
Closes #5198. Closes #5142. Closes #4980
2017-10-04 12:12:06 +02:00
Tom Christie
5dcb460793 Update link to monthly report.
Closes #5474.
2017-10-03 12:15:52 +01:00
Ryan P Kilby
e0a6c4b5bd Clarify 'to_internal_value()' validation behavior (#5466) 2017-10-02 13:51:48 +01:00
Lim H
62ecbf2817 Add drf-openapi (#5470)
* Add DRF OpenAPI as a 3rd party tool for DRF doc

* Add image

* Add third party packages section to schema doc

* Add DRF OpenAPI reference
2017-10-02 11:16:33 +02: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
Carlton Gibson
5c2290d973 Add note on not using floats with CursorPagination (#5459)
Closes #5160, closes #5164.
2017-09-27 12:23:54 +02:00
Carlton Gibson
1bcee8c60c Document extra parameters to get_schema_view 2017-09-25 16:25:40 +02:00
Matt Davis
107e8b3d23 Make DEFAULT_PAGINATION_CLASS None by default. (#5170)
* Changes to the paginator defaults and settings

Require a default paginator be specified when using the page size
setting.
https://github.com/encode/django-rest-framework/issues/5168

* DRF-5168 import warnings

missed this in last commit

* Add a system checks file

Add a check for pagination settings for the 3.7 upgrade cycle.

* more compatible import approach

* missing bactic

* revised language and approach to import the system check

Adds a rest framework app config.

* Adjust doc wording
2017-09-25 15:36:30 +02:00
Paolo Melchiorre
11e5851196 Update pagination.md
Fixed 2 missing spaces in Custom Pagination snippet
2017-09-25 11:30:21 +02:00
Carlton Gibson
aecca9d8e8 Add note on force_authenticate + refresh_from_db
…in case you’re reusing the same in-memory user whilst updating it in the DB.

Closes #5016, closes #5066, closes #4102
2017-09-25 11:14:36 +02:00
Ryan P Kilby
215248c042 Add 'STRICT_JSON' docs 2017-09-25 09:08:20 +02:00
Carlton Gibson
cb6e7e0fdd Drop erroneous ) in release notes 2017-09-20 14:23:51 +02:00
Carlton Gibson
7d6d043531 Fix DateTimeField TZ handling (#5435)
* Add failing TZ tests for DateTimeField

- tests "current" timezone activation
- tests output for non-UTC timezones

* Update DateTimeField TZ aware/naive test output

* Fix DateTimeField TZ handling

* Add Release Note for BC change
2017-09-20 12:15:15 +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
Carlton Gibson
7b1582e00e Allow schema = None. Deprecate exclude_from_schema (#5422)
* Add tests for schema exclusions

* Move exclusion check to should_include_endpoint

* Update docs

* Switch to using `schema = None`

* Test PendingDeprecationWarnings

* Add note to release notes.

* s/deprecated/pending deprecation/

* Add PR link to release notes

* Correct typo in test class name

* Test 'exclude_from_schema' deprecation warning message (#1)

* Correct deprecation warning message
2017-09-20 11:29:47 +02:00
Carlton Gibson
d54df8c438 Refactor schema generation to allow per-view customisation (#5354)
* Initial Refactor Step

* Add descriptor class
* call from generator
* proxy back to generator for implementation.

* Move `get_link` to descriptor

* Move `get_description` to descriptor

* Remove need for generator in get_description

* Move get_path_fields to descriptor

* Move `get_serializer_fields` to descriptor

* Move `get_pagination_fields` to descriptor

* Move `get_filter_fields` to descriptor

* Move `get_encoding` to descriptor.

* Pass just `url` from SchemaGenerator to descriptor

* Make `view` a property

Encapsulates check for a view instance.

* Adjust API Reference docs

* Add `ManualSchema` class

* Refactor to `ViewInspector` plus `AutoSchema`

The interface then is **just** `get_link()`

* Add `manual_fields` kwarg to AutoSchema

* Add schema decorator for FBVs

* Adjust comments

* Docs: Provide full params in example

Ref feedback b52e372f8f (r137254795)

* Add docstring for ViewInstpector.__get__ descriptor method.

Ref https://github.com/encode/django-rest-framework/pull/5354#discussion_r137265022

* Make `schemas` a package.

* Split generators, inspectors, views.

* Adjust imports

* Rename to EndpointEnumerator

* Adjust ManualSchema to take `fields`

… and `description`.

Allows `url` and `action` to remain dynamic

* Add package/module docstrings
2017-09-14 09:46:34 +01:00
Jozef
7037ce88e9 Fix throttling documentation about Remote-Addr (#5414)
Clarify in docs that REMOTE_ADDR is part of the WSGI environ, not an HTTP header.
2017-09-12 12:08:32 +01:00
Sanjuro Jogdeo
0e341c24b4 Update get_object() example in permissions.md (#5401)
* Update get_object() example in permissions.md 

I'm a bit confused about the example that's provided in the 'Object level permissions' section.  Other examples (e.g. Tutorial 3 - Class Based Views) provided a pk to get_object().  It doesn't seem like this example has any way of identifying a specific object.  

Just in case I'm correct, I've prepared this pull request. But if I'm wrong, would it be possible for you to explain the example I modified?  

Many Thanks...

* Adjust patch
2017-09-08 18:51:16 +02:00
ersel-ionova
13222e45bc Make status_code documentation more readable. (#5400)
* Make status_code documentation more readable.

* Update status-codes.md
2017-09-08 16:53:17 +01:00
Irvan
b11f37eaf3 Fixed the MultipleFieldLookupMixin example to properly check for object level permission. 2017-09-07 11:06:44 +08:00
Ryan P Kilby
af460d2b69 Add PR 5376 to release notes 2017-09-01 13:37:06 -04:00
Vadim Laletin
c0475d059d Update link to drf-writable-nested repository in third-party serializers 2017-08-29 10:39:52 +07:00
Ashish Patil
26d4977cd0 ~api-clients documentation: installation code fix 2017-08-24 15:06:48 +04:00
Scott Kelly
807b9c716c Fix doc Response data attribute description 2017-08-23 21:30:56 -05: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
Carlton Gibson
0a0bb6a871 Update release notes
For the last minute #5346
2017-08-21 20:33:51 +02:00
Carlton Gibson
81527a2863 Release notes for 3.6.4 2017-08-21 11:50:00 +02:00
Carlton Gibson
43c7af0bb5 Adjust ListField & DictField signature docs (#5333)
Closes #5301
2017-08-17 10:06:09 +01:00
Carlton Gibson
3110635685 Update JS constructor syntax (#5332)
Fixes #5247
2017-08-15 14:33:06 +01:00
Oliver Eidel
bf4b3ff0d5 Fix token param in force_authenticate example (#5284)
related_name for Token is `auth_token`, not `token`.
2017-08-14 13:09:47 +01:00
Berker Peksag
52e0f3ae08 Fix indentation of code example in chapter 7 (#5329) 2017-08-14 13:04:52 +01:00
Andrea Grandi
1799b569d8 Add documentation to create user token with the new command 2017-08-13 11:08:44 +01:00
Alexander Dutton
e80b78d1cb RemoteUserAuthentication, docs, and tests (#5306)
RemoteUserAuthentication, docs, and tests
2017-08-11 10:35:00 +01:00
Steven Johns
9b5a6bea67 Fix typo on fields.md (#5320)
> keeps you error messages

to

> keeps your error messages

and 

> more cleanly separated from your code

to 

> cleaner and more separated from your code
2017-08-09 15:21:23 -04:00
Vašek Dohnal
1f2e2dea96 Fixed typo in docs/Documenting your API (#5316) 2017-08-08 10:01:19 -04:00
Anna Ossowski
21074a02b4 Changed monthly report link (#5308)
* Removed Micropyramid as a sponsor

* Changed monthly report link
2017-08-04 15:23:54 -04:00
Didi Hoffmann
1368d3677c Added the separator line back
Accidentally also deleted a line.
2017-07-31 15:00:26 +02:00
Didi Hoffmann
ad501d41f5 Added the django user model
So it is possible to copy paste the example and it will work out of the box.
2017-07-31 14:50:36 +02:00
Anna Ossowski
2e534b31c1 Removed Micropyramid as a sponsor (#5280) 2017-07-18 09:14:49 +01:00
Tommy Beadle
2a1fd3b45a Add link to third-party package for LinkHeaderPagination. (#5270) 2017-07-12 16:45:41 +01:00
David Sanders
4091607d94 Add information in docs about djangorestframework-simplejwt package 2017-07-05 14:48:54 -06:00
Anna
fd6cc1e395 Updated monthly report link 2017-07-04 17:53:03 +02:00
Neftalí Acosta
900cae1507 Link broken
The link to the Python Exception Handling Techniques article written by Doug Hellmann is broken.

I could find the article in the URL I proposed.
2017-06-23 08:09:10 +01:00
Michael Hrivnak
5fe984b657 typo fix
removes an extraneous word
2017-06-20 15:07:45 -04:00
Aristóbulo Meneses
5002d1a9ae Update DOT docs
DOT renamed `ext` to `contrib` on their new release `1.0.0`
2017-06-17 15:02:22 +02:00
Anna
462378ba99 Added FAQ section for funding site 2017-06-15 19:02:40 +02:00
Anna
b296d3b9a3 Updated monthly report link + added Tom's PyCon talk 2017-06-05 18:19:03 +02:00
Matt Broach
e4ec1d744e Updated DjangoRestMulipleModel documentation to point to new repo location 2017-05-30 23:39:18 -04:00
Tom Christie
5267fcc8c6 Merge pull request #5159 from carltongibson/docs/get_schema_view_params
Add `generator_class` parameter to `get_schema_view` docs.
2017-05-29 12:53:49 +01:00
Tom Christie
7de34cf187 Merge pull request #5163 from khakulov/patch-2
Added documentation from where to import get_schema_view
2017-05-29 11:55:02 +01:00
Azim Khakulov
d1093b5326 Added documentation from where to import get_schema_view 2017-05-23 02:08:20 +02:00
Carlton Gibson
53b3b83b04 Add generator_class parameter to docs.
`get_schema_view` accepts `generator_class` parameter
2017-05-22 11:55:19 +02:00
Xavier Ordoquy
6831472a62 Remove ambiguous reference to former DjangoFilterBackend. 2017-05-19 23:50:13 +02:00
Xavier Ordoquy
703655bc65 Non model Viewset requires base_name when registering to router. 2017-05-19 23:35:25 +02:00
Tom Christie
996e587398 Remove broken bit of merge commit 2017-05-12 18:25:06 +01:00
Tom Christie
cdd15f3769 Remove broken bit of merge commit 2017-05-12 18:23:35 +01:00
Tom Christie
a99f12f1c6 Merge branch 'master' into version-3-6-3 2017-05-12 17:03:32 +01:00
Tom Christie
42f80c65a9 Version 3.6.3 2017-05-12 16:52:27 +01:00
Ryan P Kilby
7322aa6b68 Simplify django-filter docs, add drf integration link 2017-05-03 11:03:11 -04:00
Tom Christie
67f382394b Update third-party-packages.md 2017-05-03 09:25:40 +01:00
Xavier Ordoquy
a1e6d83533 Add missing pk keyword argument to the detail_route. 2017-05-03 02:19:30 +02:00
Tom Christie
e1fdb895b5 Included Python 3.6 in the requirements
Refs #5108
2017-05-02 09:54:45 +01:00
Tom Christie
e7483133ea Update browsable-api.md 2017-05-01 11:49:42 +01:00
Tom Christie
a857dab79c Merge pull request #5103 from folz/patch-1
Improve grammar in .force_authenticate() docs
2017-04-30 17:56:33 +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
Rodney Folz
971bc066c5 Improve grammar in .force_authenticate() docs
* Remove unnecessary comma
* Remove the "and simple" copied from the line above.
* Add "entirely" to emphasize that this function bypasses the authentication step.
2017-04-27 15:44:06 -07:00
Tom Christie
aafd0a644f Merge pull request #4979 from linovia/feature/improve_schema_shortcut
Restrict doc & schema shortcuts to a subset of urls
2017-04-27 16:58:01 +01:00
José Padilla
d45c12ff8c
Improve books section 2017-04-26 09:16:45 -04:00
José Padilla
fff9837195 Merge pull request #5098 from pydanny/fix-book-order
Corrected order of books. Apologies to @limedaring
2017-04-25 21:31:39 -04:00
Daniel Roy Greenfeld
dfb0e6ff2d Corrected order of books. Apologies to @limedaring 2017-04-25 17:42:14 -07:00
Daniel Roy Greenfeld
4be21cf854 add Two Scoops of Django 1.11 to tutorials and resources 2017-04-25 14:36:36 -07:00
Mike Lissner
b8520a1f2e Updates the core json media type in the docs
Per: http://www.django-rest-framework.org/topics/3.5-announcement/#corejson-media-type

(I was *wondering* why this didn't seem to work!)
2017-04-20 11:37:46 -07:00
Xavier Ordoquy
778aee1bb3 Merge master. 2017-04-19 07:56:39 +02:00
Xavier Ordoquy
36e5759498 Add documentation for the get_schema_view new argument: patterns 2017-04-19 07:49:13 +02:00
Sergey Smirnov
34f88dc3f8 Add Django 1.11 into *.md and setup.py 2017-04-17 19:42:50 +02:00
Tom Christie
fd72a814f8 Merge pull request #5073 from khakulov/patch-1
Clarify get_schema_fields signature
2017-04-12 17:22:33 +01:00
Tom Christie
853f393112 Merge pull request #5065 from felixxm/django-guardian-version
Bumped django-guardian version.
2017-04-12 17:02:52 +01:00
Azim Khakulov
613aa61ada Clarify get_schema_fields signature
I had to look for the signature of `get_schema_fields()`in source code.
2017-04-12 12:25:27 +02:00
Anna
1bbfc0e87c Updated monthly report link on funding page 2017-04-10 22:37:49 +02:00
Mariusz Felisiak
e70b920d2e
Bumped django-guardian version. 2017-04-09 22:21:42 +02: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
Tom Christie
20c7a24c14 Merge pull request #5025 from aaronn/thirdparty
Add drfpasswordless to Third Party Packages and Authentication pages
2017-03-27 20:12:38 +01:00
aaronykng
0400cbbc4c Added drfpasswordless to Authentication docs 2017-03-27 12:08:07 -07:00
Jack Evans
73bd709813 Document adding django_filters to installed apps
Reminds users to add `django_filters` to their `INSTALLED_APPS` as detailed in the django-filter documentation https://django-filter.readthedocs.io/en/develop/guide/install.html
2017-03-27 16:13:50 +01:00
aaronykng
10d8ad601c Added drfpasswordless to third party packages topic page. 2017-03-27 07:27:46 -07:00
aaronykng
aa92736d72 Added drfpasswordless to authentication topic page. 2017-03-27 07:19:11 -07:00
Tom Christie
63a4021472 Add whitespace between user quotes on funding page 2017-03-27 11:18:20 +01:00
Nick Timkovich
51c6d23a05 Mention where the mixins live
Ctrl-F on the ViewSets page doesn't show where the `mixins.SomeMixin...` classes come from.
2017-03-19 17:17:37 -05:00
Dark Goat
3cf01b7350 Update 7-schemas-and-client-libraries.md
fix django url syntax.
2017-03-16 19:37:48 +08:00
Tom Christie
f3ccad8fea Merge pull request #4988 from ossanna16/master
Updated testimonial name on funding site
2017-03-16 09:11:00 +00:00
Anna
6a8aed03a8 Updated testimonial name on funding site 2017-03-16 06:00:57 +01: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
Anna
ade7a254d5 Fixed mistakes for funding page PR 2017-03-10 23:06:01 +01:00
Anna
628c356832 Merge remote-tracking branch 'upstream/master' 2017-03-10 22:28:20 +01:00
Tom Christie
1d34bc0b92 Update release notes 2017-03-10 14:38:24 +00:00
Tom Christie
0fe0a91aed Remove erronous HTML in example. Closes #4958 2017-03-10 08:51:19 +00:00
Anna
60bb3b0958 Updated funding page 2017-03-10 06:30:31 +01:00
Tom Christie
b884bdd391 Add 3.6 release to index 2017-03-09 16:16:22 +00:00
Tom Christie
1d4290eb7b Tweak docs 2017-03-09 15:59:29 +00:00
Tom Christie
86931b01b6 Note dependancies in docs 2017-03-09 14:59:00 +00:00
Tom Christie
52db57a6e7 Version 3.6 (#4943) 2017-03-09 14:49:51 +00:00
Tibo Beijen
cf5d401a0e Allow required false and default (#4692)
* Default value will now be used when serializing if key or attribute is missing.
2017-03-07 13:19:19 +00:00
Md. Al-Amin
8a14b39e7d Added doc for removing pagination in generic-view. (#4940) 2017-03-06 18:33:27 +00:00
Tom Christie
0b708f04e1 Client library & API documentation docs (#4939) 2017-03-06 12:42:51 +00:00
Tom Christie
68d2020112 Live API documentation (#4755) 2017-03-03 15:24:37 +00: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
Anna
ff4f252003 Fixed broken mail link in tutorials and resources 2017-03-03 00:40:57 +01:00
Peter JJ MacDonald
dfea596b0f Update django-filter requirement (#4933) 2017-03-01 21:27:23 +00:00
Binoj David
d58c89adc1 Fix Schemas Example URL 2017-02-28 22:45:17 +05:30
José Padilla
b936d829a6 Fix mailto link (#4923) 2017-02-26 09:08:03 +00:00
Anna Ossowski
e922d91614 Created Tutorials and Resources, cleaned up Third Party Packages (#4910)
* Updated Support section and added funding email
* Created new tutorials and resources section, cleaned up third party packages section
* Created Jobs section
2017-02-24 12:55:34 +00:00
Tom Christie
d82dbc0925 Add MicroPyramid 2017-02-21 21:18:53 +00:00
Vadim
d390762e18 Add drf-writable-nested package to third-party serializers (#4913) 2017-02-20 15:16:27 +00:00
Akhil Lawrence
963cb4cdc6 Corrected documentation 2017-02-18 13:20:03 +05:30
Eduard Iskandarov
de8fcbf696 Refs: #4256 delete unrelevant documentation 2017-02-14 13:27:33 +03:00
Tom Christie
eb5774229f Version 3.5.4 (#4894) 2017-02-10 11:15:39 +00:00
Michael Borisov
176831e22b Missing comma (#4889) 2017-02-08 15:17:58 +00:00
李扬
cbad236f6d Add max_length and min_length arguments for ListField (#4877) 2017-02-06 09:36:03 +00:00
Tom Christie
79f431c44a Update sponsors on README to include rollbar (#4876) 2017-02-03 17:10:52 +00:00
Tom Christie
222f80f340 Merge branch 'master' of github.com:tomchristie/django-rest-framework 2017-02-03 16:54:23 +00:00
Tom Christie
3c93c3f7b4 Added Rollbar to premium sponsors 2017-02-03 16:54:13 +00:00
Anna Ossowski
a8dbc22028 Updated Support section and added funding email (#4860) 2017-01-28 22:41:21 +00:00
Tom Christie
b1eade4e32 Update machinalis links 2017-01-27 12:57:26 +00:00
Anna Ossowski
245b356ee7 Updated Machinalis links (#4856) 2017-01-27 10:35:25 +00:00
nmgeek
ab0c57718a Direct readers to info on how to add viewset docs (#4844)
I believe the original statement was wrong.  You can, in fact, document the various API endpoints of a ViewSet.
2017-01-24 09:57:14 +00:00
Luca
635dc03529 Parametrizable viewset custom views reverse name (#4821) 2017-01-19 15:20:34 +00:00
Emmanouil Konstantinidis
81195aabbf Include a link to the django-rest-framework-api-key package 2017-01-18 14:36:43 +00:00
Mitchel Humpherys
d6c6df40c6 docs: tutorial: Minor grammar "fix" (#4801) 2017-01-10 09:04:07 +00:00
Artem Muterko
b352c8a24c Fix some typos in documentation 2017-01-08 15:34:52 +02:00
wim glenn
e2c35920d1 fix a spelling error in api-guide (#4788) 2017-01-06 22:46:56 +00:00
Roman Vasilyev
64e801e479 get view for django 'virtual hosts' (#4776)
Brill, thanks! 👍
2017-01-06 22:46:36 +00:00
Tom Christie
cf3862d56d Update 3.0-announcement.md
Closes #4785
2017-01-06 07:24:28 +00:00
wim glenn
718764f591 add links to djangorestframework-queryfields to docs (#4786) 2017-01-06 06:40:50 +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
Ian Clark
eddc34f4c8 Add Serializer Extensions documentation (#4777) 2017-01-04 08:40:42 +00:00
Ryan P Kilby
11fd3bf108 Add disabling of declared fields on serializer subclasses (#4764)
* Add test for disabling declared fields on child
* Check that declared base field is not in attrs
* Update meta inheritance docs to include serializer
* Test that meta fields cannot be declared as None
* Add docs example for declarative field disabling
2017-01-03 21:14:19 +00:00
Makedonsky
69366a11d7 modify documenting-your-api docs topic 2017-01-03 13:17:07 +02:00
robert
492444eb2e added drf-flexfields addon info 2017-01-02 17:03:03 -06:00
Emmanuelle Delescolle
d98a0772d0 Add DRF-Base64 to third-party serializers
Add DRF-Base64, which provides serializers to handle base64-encoded files, to third-party serializers packages
2016-12-31 08:16:45 +01:00
Emmanuelle Delescolle
f1cbf51b43 Add drf-schema-adapter to 3rd party metadata mods 2016-12-25 10:06:47 +01:00
Masashi SHIBATA
c2367fb017 Fix documentation's sample code in API Guide (#4756) 2016-12-17 13:00:29 +00:00
Eduard Iskandarov
ebe174c0d7 add per-view custom exception handler support (#4753) 2016-12-15 12:36:40 +00:00
Allard Hoeve
0175ea4809 Add drf-oidc-auth to 3rd party mods 2016-12-14 20:15:39 +01:00
Tom Christie
89d22942a6 Add missing docs on RequestsClient. Closes #4747. 2016-12-12 10:08:54 +00:00
Tom Christie
7ecd4f7813 Merge branch 'master' of github.com:tomchristie/django-rest-framework 2016-12-09 16:07:11 +00:00
Tom Christie
38bde343f8 Update sponsor link 2016-12-09 16:06:59 +00:00
Daniel Rech
761d53e923 Updated Link ti Django Docs
The Url to the settings/#caches Link changed in Django documentation.
2016-12-05 11:36:03 +01:00