Commit Graph

654 Commits

Author SHA1 Message Date
Tom Christie
f131e533ed Docs, docs, docs, docs, docs, docs 2012-11-18 17:57:07 +00:00
Tom Christie
2263ed8b94 Tweak 2012-11-16 23:24:36 +00:00
Tom Christie
0eba278e13 Improve pagination docs 2012-11-16 23:22:23 +00:00
Tom Christie
e801e21210 Merge pull request #422 from markotibold/max_length_for_modelserializers
Max length for modelserializers
2012-11-16 14:54:16 -08:00
Tom Christie
e40000c834 Merge pull request #408 from markotibold/file_and_image_fields
Added a FileField and an ImageField
2012-11-16 14:48:42 -08:00
Tom Christie
31f01bd631 Polishing to page size query parameters & more docs 2012-11-16 22:45:57 +00:00
Marko Tibold
f801e5d305 Simplified docs a bit for FileField and ImageField.
Added note about MultipartParser only supporting file uploads and Django's default upload handlers.
2012-11-16 23:44:55 +01:00
Marko Tibold
0076e2f462 Added brief docs for URLField and SlugField. 2012-11-16 23:23:34 +01:00
Tom Christie
9973cf329a Merge pull request #412 from minddust/custom_page_size_per_request
support for custom page size per request
2012-11-16 13:45:27 -08:00
Tom Christie
2f2bde69e4 Docs, tox and travis use django-filter 0.5.4 2012-11-16 20:58:49 +00:00
Tom Christie
c5765641a4 Fix typo 2012-11-16 17:28:08 +00:00
Marko Tibold
b4cfb46a56 WIP on docs for File- and ImageFileds. 2012-11-16 00:22:08 +01:00
Stephan Groß
3ae203a018 updated script to just use page_size_kwarg 2012-11-15 12:06:43 +01:00
Stephan Groß
38e94bb8b4 added global and per resource on/off switch + updated docs 2012-11-15 11:15:05 +01:00
Rob Romano
321ba156ca Renamed AuthTokenView to ObtainAuthToken, added obtain_auth_token var, updated tests & docs. Left authtoken.urls in place as example. 2012-11-14 12:51:00 -08:00
Rob Romano
eb20b5663e Added documentation on how to use the token authentication login view. 2012-11-14 12:48:03 -08:00
Stephan Groß
1e83b60a43 added description how to use the auth token 2012-11-14 18:00:59 +01:00
Stephan Groß
5967f15f7f updated docs 2012-11-14 16:11:35 +01:00
Tom Christie
957700ecfb Remove OAuth2 from docs 2012-11-13 11:26:45 +00:00
Tom Christie
e224061189 Support for read_only_fields on ModelSerializer classes 2012-11-09 17:01:20 +00:00
Tom Christie
8953a60196 Merge with master 2012-11-09 13:49:52 +00:00
Tom Christie
9aaeeacdfe Minor docs tweak. 2012-11-09 13:39:40 +00:00
Tom Christie
71ef58e154 Typo 2012-11-09 13:17:00 +00:00
Tom Christie
c7df9694b5 Merge pull request #383 from tomchristie/filtering
Support for filtering backends
2012-11-09 05:07:34 -08:00
Tom Christie
ff1234b711 Updated filteing docs. 2012-11-09 13:05:36 +00:00
Tom Christie
bc6f2a1703 Make default FILTER_BACKEND = None 2012-11-08 21:46:53 +00:00
Tom Christie
0089f0faa7 Add media_type to example file parser 2012-11-08 20:43:23 +00:00
Tom Christie
34c5fb0cc6 Add filtering into documentation 2012-11-07 21:28:10 +00:00
Tom Christie
47b534a13e Make filtering optional, and pluggable. 2012-11-07 21:07:24 +00:00
Stephan Groß
e02a8470e8 fixed typo 2012-11-06 21:18:49 +01:00
Stephan Groß
4136b7e44b fixed typo in html status code 2012-11-06 21:11:05 +01:00
Tom Christie
6d3bb67aa6 Add pk_url_kwarg to hyperlinked fields 2012-11-06 17:11:52 +00:00
Stephan Groß
2c52a2581f added slug support for HyperlinkedIdentityField 2012-11-06 17:02:34 +01:00
Tom Christie
b19c58ae17 Support for HTML error templates. Fixes #319. 2012-11-06 10:44:19 +00:00
Tom Christie
455a8cedcf Tweaks 2012-11-05 17:03:22 +00:00
Tom Christie
1418d104a8 Tweak related field docs now that queryset is no longer required. 2012-11-05 16:44:26 +00:00
Tom Christie
9731b95fc3 Merge pull request #347 from minddust/master
support for passing custom slug options to HyperlinkedRelatedField
2012-11-05 08:36:59 -08:00
Stephan Groß
85b176cf47 added docs 2012-11-05 16:51:49 +01:00
Tom Christie
b7b942c599 Swap position of instance and data keyword arguments. 2012-11-05 10:53:20 +00:00
Tom Christie
062f5caef3 Tweaks fields docs, and fix 2.0.1 version. 2012-11-01 23:40:34 +00:00
Otto Yiu
96dc9ce1ad Fixing documentation on auth/throttling guides 2012-10-31 21:27:21 -07:00
Stephan Groß
7f7f0b6ffb added missing semicolon 2012-10-31 10:41:56 +01:00
Stephan Groß
5865842019 fixed api_view decorator useage 2012-10-29 09:32:11 +01:00
Stephan Groß
2de89f2d53 remove empty rows 2012-10-29 09:29:45 +01:00
Stephan Groß
ff4804a360 fix api_view decorator useage 2012-10-29 09:25:17 +01:00
Stephan Groß
73cf859e26 add missing whitespace 2012-10-29 09:23:25 +01:00
Stephan Groß
741b387f35 fixed missplaced semicolon 2012-10-29 09:22:20 +01:00
Stephan Groß
5164f5d797 fixed missplaced semicolon 2012-10-29 09:21:27 +01:00
Stephan Groß
46e546ff23 fixed missplaced semicolon 2012-10-29 09:20:14 +01:00
Stephan Groß
72f3a7e4a7 add missing semicolon 2012-10-29 09:13:56 +01:00
Stephan Groß
842c8b4da4 add missing "`" for code formatting 2012-10-29 09:12:21 +01:00
Stephan Groß
8d2774dc97 fixed api_view decorator useage 2012-10-29 09:07:42 +01:00
Tom Christie
351382fe35 nested -> depth 2012-10-28 20:43:43 +00:00
Tom Christie
6e4ab09aae readonly -> read_only 2012-10-28 20:21:45 +00:00
Tom Christie
795f611663 Merge pull request #332 from tomchristie/tutorial-refactor
Improve fields docs
2012-10-28 13:18:51 -07:00
Tom Christie
3906ff0df5 Improve fields docs 2012-10-28 20:18:02 +00:00
Tom Christie
3d3df22d82 Merge pull request #330 from tomchristie/tutorial-refactor
Tutorial refactor
2012-10-28 12:42:10 -07:00
Tom Christie
12c363c1fe TemplateHTMLRenderer, StaticHTMLRenderer 2012-10-28 18:12:56 +00:00
Tom Christie
d995742afc Add AllowAny permission 2012-10-27 20:04:33 +01:00
Tom Christie
cef379db06 2.0 Announcement 2012-10-27 18:39:17 +01:00
Tom Christie
ec1429ffc8 Tweaks 2012-10-27 17:27:12 +02:00
Jamie Matthews
5180b72565 Documentation for function-based view decorators 2012-10-27 13:53:07 +01:00
Tom Christie
c221bc6f6f Use context dict in HTMLRenderer 2012-10-26 17:30:45 +02:00
Tom Christie
d4063eb02e Fix incorrect method signature in docs 2012-10-26 12:46:31 +01:00
Jamie Matthews
41d27b1a30 Fix section headings in generic views docs 2012-10-25 14:22:36 +01:00
Jamie Matthews
1ceca69e5f Update generic view documentation 2012-10-25 13:50:48 +01:00
Tom Christie
d97c712124 Fix typo reported by @diviei 2012-10-24 20:49:09 +02:00
Jamie Matthews
d60d598e02 Clean up internal names and documentation 2012-10-24 11:43:30 +01:00
Jamie Matthews
ac2d39892d Add cross-field validate method 2012-10-24 11:39:17 +01:00
Jamie Matthews
388a807f64 Switch from clean_<fieldname> to validate_<fieldname>, clarify documentation 2012-10-24 11:27:01 +01:00
Jamie Matthews
51fae73f3d Implement per-field validation on Serializers 2012-10-24 09:28:10 +01:00
Marko Tibold
aba0172f5c Update docs/api-guide/fields.md
Fix typo.
2012-10-22 21:31:15 +03:00
Tom Christie
95a670de41 Merge field changes: .default and .widget 2012-10-22 15:24:09 +01:00
Tom Christie
13d0a82939 Minor docs tweaks 2012-10-21 17:40:49 +01:00
Marko Tibold
65d4970bf7 Changed IsAdmin -> IsAdminUser in example 2012-10-21 16:34:50 +02:00
Marko Tibold
71a93930fd Fixing spelling errors. 2012-10-21 16:34:07 +02:00
Tom Christie
efabd2bb1b docs, docs, docs, docs, docs, docs, docs 2012-10-19 19:59:55 +01:00
Tom Christie
0c65d9babe Merge pull request #304 from tomchristie/consitent_settings
Make settings consistent with corrosponding view attributes
2012-10-18 04:46:01 -07:00
Tom Christie
e8f542aac8 Minor docs fix 2012-10-18 09:19:38 +01:00
Tom Christie
fed235dd01 Make settings consistent with corrosponding view attributes 2012-10-17 23:09:11 +01:00
Tom Christie
e126b61542 Negotiation API finalized. .select_renderers and .select_parsers 2012-10-17 22:58:18 +01:00
Tom Christie
fb56f215ae Added media_type to .parse() - Consistency with renderer API. 2012-10-17 22:39:07 +01:00
Tom Christie
4231995fbd parser_context includes view, request, args, kwargs. (Not meta and upload_handlers)
Consistency with renderer API.
2012-10-17 22:19:59 +01:00
Tom Christie
99d48f9003 Drop .parse_string_or_stream() - keep API minimal. 2012-10-17 22:07:56 +01:00
Tom Christie
cab4a2a5ad Split up doc sections more cleanly 2012-10-17 15:41:57 +01:00
Tom Christie
b78872b7db Use two seperate exceptions - AuthenticationFailed, and NotAuthenticated
Cleaner seperation of exception and resulting HTTP response.
Should result in more obvious error messages.
2012-10-17 15:23:36 +01:00
Tom Christie
a4d500ba10 Use correct status code 2012-10-17 15:10:11 +01:00
Tom Christie
5ae49a4ec4 Add docs for 401 vs 403 responses 2012-10-17 14:59:53 +01:00
Tom Christie
4c17d1441f Add Unauthenticated exception. 2012-10-17 14:59:37 +01:00
Tom Christie
bd8360c826 Highlight use of permissions alnog with authentication 2012-10-17 14:02:30 +01:00
Tom Christie
9c1fba3483 Tweak parsers to take parser_context 2012-10-15 13:27:50 +01:00
Jens Alm
c942726509 Added docs, integer fields and refactored models.TextField to use CharField
I realized that per the django forms, there is no need for a separate
TextField, an unlimited CharField is perfectly good.
Also added default field for the different IntegerField types
2012-10-15 13:46:44 +02:00
Tom Christie
41dd63b3b0 Merge branch 'restframework2' of https://github.com/tomchristie/django-rest-framework into restframework2 2012-10-14 22:43:41 +01:00
Tom Christie
551c86c43a Documentation for parsers 2012-10-14 22:43:07 +01:00
Tom Christie
7a89d7a770 Work on docs 2012-10-14 20:46:38 +01:00
Tom Christie
27b8904ffe Fix typo 2012-10-13 23:28:05 +02:00
Tom Christie
fe5db41949 Fix typo 2012-10-13 15:12:44 +01:00
Tom Christie
7608cf1193 Improve documentation for Requests 2012-10-13 15:07:43 +01:00
Tom Christie
648d2be29b Make sure JSON output in Browseable API is nicely indented 2012-10-10 12:15:18 +01:00
Tom Christie
ccd2b0117d Permissions and throttles no longer have a view attribute on self. Explicitly passed to .has_permissions(request, view, obj=None) / .allow_request(request, view) 2012-10-10 10:02:37 +01:00
Tom Christie
9bbc1cc403 Add flag in get_related_field 2012-10-09 17:49:04 +01:00
Tom Christie
b0c370dd2b Fixed couple of incorrect imports in the docs 2012-10-09 17:36:03 +01:00
Tom Christie
52a2ff8f77 Docs tweaks 2012-10-09 16:44:49 +01:00
Tom Christie
97a7f27c82 Rename HTMLTemplateRenderer -> HTMLRenderer, DocuemntingHTMLRenderer -> BrowseableAPIRenderer 2012-10-09 15:58:48 +01:00
Tom Christie
b581ffe323 Docs tweaks 2012-10-08 15:46:52 +01:00
Tom Christie
f79ed6175d Add RetrieveDestroyAPIView and remove Metadata mixin 2012-10-08 14:13:15 +01:00
Tom Christie
9bc4aead65 Tweak fields docs 2012-10-05 19:26:57 +01:00
Tom Christie
cc21948a69 Fix django 1.3 bug 2012-10-05 17:02:33 +01:00
Tom Christie
84958d131a Doc style tweaks 2012-10-05 15:22:30 +01:00
Tom Christie
3e862c7737 Tweak view slightly 2012-10-05 14:22:02 +01:00
Tom Christie
6a15556384 Docs tweaks 2012-10-05 14:00:02 +01:00
Tom Christie
1a09983dfc Tweak doc headings 2012-10-05 13:51:09 +01:00
Tom Christie
2575ea92aa Docs for template responses 2012-10-05 13:04:34 +01:00
Tom Christie
26c7d6df6c HTMLTemplateRenderer working 2012-10-05 12:13:44 +01:00
Tom Christie
d07dc77e91 Accepted media type uses most specific of client/renderer media types. 2012-10-05 10:23:47 +01:00
Tom Christie
bcd2caf559 Abstract out the app_label on test models 2012-10-04 09:18:46 +01:00
Tom Christie
b89125ef53 Update view docs slightly 2012-10-02 21:26:15 +01:00
Tom Christie
ab173fd8f9 Fix bug where pk could be set in post data 2012-10-02 15:37:13 +01:00
Tom Christie
e7685f3eb5 URL overrides in settings fixed up slightly 2012-10-02 15:24:42 +01:00
Tom Christie
8855a462c6 Clean up docs slightly 2012-10-02 11:48:25 +01:00
Tom Christie
b526b82abf Placeholder for FBV docs 2012-10-02 11:04:06 +01:00
Tom Christie
34637bf857 Make example more realistic and less of a toy 2012-10-02 11:03:51 +01:00
Tom Christie
ae8a827004 Make 'results_field' attribute of BasePaginationSerializer public. 2012-10-02 10:40:43 +01:00
Tom Christie
2284e592de Clean up reverse docs slightly 2012-10-02 10:40:04 +01:00
Tom Christie
a8f6ac3f3a Renderer documentation 2012-10-02 10:39:28 +01:00
Tom Christie
dae6d09398 Add example of using paginator in a view 2012-10-01 16:27:22 +01:00
Tom Christie
8d1d990187 Pagination docs 2012-10-01 16:17:01 +01:00
Tom Christie
b16fb57771 Expand pagination support, add docs 2012-10-01 15:49:19 +01:00
Tom Christie
43d3634e89 Docs tweaking 2012-09-30 15:55:24 +01:00
Tom Christie
ee36e4ab0c Only display forms when user has permissions. #159 2012-09-27 21:51:46 +01:00
Tom Christie
0cc7030aab Fix @api_view decorator tests 2012-09-26 21:47:19 +01:00
Tom Christie
4b691c4027 Change package name: djangorestframework -> rest_framework 2012-09-20 13:06:27 +01:00
Tom Christie
a96211d3d1 Simplify negotiation. Drop MSIE hacks. Etc. 2012-09-16 21:48:55 +01:00
Tom Christie
eb761be9d0 Flesh out resources/routers part of tutorial 2012-09-14 12:43:14 +01:00
Tom Christie
886f8b4751 Tweak throttles and improve docs 2012-09-14 08:54:58 +01:00
Tom Christie
d8b5d6603e Tweak copy 2012-09-13 18:35:06 +01:00
Tom Christie
6c109ac60f Improve throttles and docs 2012-09-13 18:32:56 +01:00
Tom Christie
b16c45aa6d Tweak throttling/permissions/auth docs 2012-09-13 09:39:16 +01:00
Tom Christie
003a65f0e0 Tweaks to Token auth 2012-09-12 20:39:22 +01:00
Tom Christie
dac4cb9e8b GitHub link in toolbar 2012-09-12 13:11:26 +01:00
Tom Christie
c85f799ade Updating docs 2012-09-12 10:12:13 +01:00
Tom Christie
b5e07abc15 Move quote below title for consistency 2012-09-08 22:13:11 +01:00
Tom Christie
247696e820 Links to source files in docs 2012-09-08 22:06:13 +01:00
Mjumbe Wawatu Poe
8df71f4d1d Get rid of the BaseToken abstract model 2012-09-07 16:19:15 -04:00
Mjumbe Wawatu Poe
f741cdae44 Move TokenAuthentication class into djangorestframework.authentication 2012-09-07 16:15:33 -04:00
Mjumbe Wawatu Poe
3b1404bd7d Rename the default token class to "BasicToken" 2012-09-07 14:23:53 -04:00
Mjumbe Wawatu Poe
36cd91bbbe Update docs for tokenauth 2012-09-07 14:12:46 -04:00
Tom Christie
c648f2786f TODO notes in docs 2012-09-06 16:46:56 +01:00
Tom Christie
c707034649 Add more settings to settings.py 2012-09-06 15:57:16 +01:00
Tom Christie
224b538b31 Tidying up docs 2012-09-05 21:14:00 +01:00
Tom Christie
3a106aed79 Flesh out authentication docs 2012-09-05 20:10:06 +01:00
Tom Christie
ef5279e97c Improve docs 2012-09-05 13:03:55 +01:00
Tom Christie
40d1821f2d Add missing doc files 2012-09-05 10:01:43 +01:00
Tom Christie
deedf6957d REST framework 2 docs 2012-09-01 20:26:27 +01:00