From 152c385f4de37558fe4e522abad5b97f0cf7ddce Mon Sep 17 00:00:00 2001 From: Sébastien Piquemal Date: Wed, 25 Jan 2012 00:11:54 +0200 Subject: enhanced request how-to + example --- examples/sandbox/views.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'examples/sandbox') diff --git a/examples/sandbox/views.py b/examples/sandbox/views.py index f7a3542d..998887a7 100644 --- a/examples/sandbox/views.py +++ b/examples/sandbox/views.py @@ -23,6 +23,7 @@ class Sandbox(View): 5. A code highlighting API. 6. A blog posts and comments API. 7. A basic example using permissions. + 8. A basic example using enhanced request. Please feel free to browse, create, edit and delete the resources in these examples.""" @@ -33,5 +34,6 @@ class Sandbox(View): {'name': 'Object store API', 'url': reverse('object-store-root')}, {'name': 'Code highlighting API', 'url': reverse('pygments-root')}, {'name': 'Blog posts API', 'url': reverse('blog-posts-root')}, - {'name': 'Permissions example', 'url': reverse('permissions-example')} + {'name': 'Permissions example', 'url': reverse('permissions-example')}, + {'name': 'Simple request mixin example', 'url': reverse('request-example')} ] -- cgit v1.2.3 From 2cdff1b01e3aca6c56cef433e786e3ae75362739 Mon Sep 17 00:00:00 2001 From: Sébastien Piquemal Date: Tue, 7 Feb 2012 16:52:15 +0200 Subject: modified examples, somethin' still broken, can't find what --- examples/sandbox/views.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'examples/sandbox') diff --git a/examples/sandbox/views.py b/examples/sandbox/views.py index 998887a7..49b59b40 100644 --- a/examples/sandbox/views.py +++ b/examples/sandbox/views.py @@ -2,6 +2,7 @@ from django.core.urlresolvers import reverse from djangorestframework.views import View +from djangorestframework.response import Response class Sandbox(View): @@ -28,7 +29,7 @@ class Sandbox(View): Please feel free to browse, create, edit and delete the resources in these examples.""" def get(self, request): - return [{'name': 'Simple Resource example', 'url': reverse('example-resource')}, + return Response([{'name': 'Simple Resource example', 'url': reverse('example-resource')}, {'name': 'Simple ModelResource example', 'url': reverse('model-resource-root')}, {'name': 'Simple Mixin-only example', 'url': reverse('mixin-view')}, {'name': 'Object store API', 'url': reverse('object-store-root')}, @@ -36,4 +37,4 @@ class Sandbox(View): {'name': 'Blog posts API', 'url': reverse('blog-posts-root')}, {'name': 'Permissions example', 'url': reverse('permissions-example')}, {'name': 'Simple request mixin example', 'url': reverse('request-example')} - ] + ]) -- cgit v1.2.3 From af9e4f69d732cc643d6ec7ae13d4a19ac0332d44 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 21 Feb 2012 20:12:14 +0000 Subject: Merging master into develop --- examples/sandbox/views.py | 65 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 46 insertions(+), 19 deletions(-) (limited to 'examples/sandbox') diff --git a/examples/sandbox/views.py b/examples/sandbox/views.py index 49b59b40..34216ad2 100644 --- a/examples/sandbox/views.py +++ b/examples/sandbox/views.py @@ -1,40 +1,67 @@ """The root view for the examples provided with Django REST framework""" -from django.core.urlresolvers import reverse +from djangorestframework.utils import reverse from djangorestframework.views import View from djangorestframework.response import Response class Sandbox(View): - """This is the sandbox for the examples provided with [Django REST framework](http://django-rest-framework.org). + """ + This is the sandbox for the examples provided with + [Django REST framework][1]. - These examples are provided to help you get a better idea of some of the features of RESTful APIs created using the framework. + These examples are provided to help you get a better idea of some of the + features of RESTful APIs created using the framework. - All the example APIs allow anonymous access, and can be navigated either through the browser or from the command line... + All the example APIs allow anonymous access, and can be navigated either + through the browser or from the command line. - bash: curl -X GET http://api.django-rest-framework.org/ # (Use default renderer) - bash: curl -X GET http://api.django-rest-framework.org/ -H 'Accept: text/plain' # (Use plaintext documentation renderer) + For example, to get the default representation using curl: + + bash: curl -X GET http://rest.ep.io/ + + Or, to get the plaintext documentation represention: + + bash: curl -X GET http://rest.ep.io/ -H 'Accept: text/plain' The examples provided: - 1. A basic example using the [Resource](http://django-rest-framework.org/library/resource.html) class. - 2. A basic example using the [ModelResource](http://django-rest-framework.org/library/modelresource.html) class. - 3. An basic example using Django 1.3's [class based views](http://docs.djangoproject.com/en/dev/topics/class-based-views/) and djangorestframework's [RendererMixin](http://django-rest-framework.org/library/renderers.html). + 1. A basic example using the [Resource][2] class. + 2. A basic example using the [ModelResource][3] class. + 3. An basic example using Django 1.3's [class based views][4] and + djangorestframework's [RendererMixin][5]. 4. A generic object store API. 5. A code highlighting API. 6. A blog posts and comments API. 7. A basic example using permissions. 8. A basic example using enhanced request. - Please feel free to browse, create, edit and delete the resources in these examples.""" + Please feel free to browse, create, edit and delete the resources in + these examples. + + [1]: http://django-rest-framework.org + [2]: http://django-rest-framework.org/library/resource.html + [3]: http://django-rest-framework.org/library/modelresource.html + [4]: http://docs.djangoproject.com/en/dev/topics/class-based-views/ + [5]: http://django-rest-framework.org/library/renderers.html + """ def get(self, request): - return Response([{'name': 'Simple Resource example', 'url': reverse('example-resource')}, - {'name': 'Simple ModelResource example', 'url': reverse('model-resource-root')}, - {'name': 'Simple Mixin-only example', 'url': reverse('mixin-view')}, - {'name': 'Object store API', 'url': reverse('object-store-root')}, - {'name': 'Code highlighting API', 'url': reverse('pygments-root')}, - {'name': 'Blog posts API', 'url': reverse('blog-posts-root')}, - {'name': 'Permissions example', 'url': reverse('permissions-example')}, - {'name': 'Simple request mixin example', 'url': reverse('request-example')} - ]) + return Response([ + {'name': 'Simple Resource example', + 'url': reverse('example-resource', request)}, + {'name': 'Simple ModelResource example', + 'url': reverse('model-resource-root', request)}, + {'name': 'Simple Mixin-only example', + 'url': reverse('mixin-view', request)}, + {'name': 'Object store API' + 'url': reverse('object-store-root', request)}, + {'name': 'Code highlighting API', + 'url': reverse('pygments-root', request)}, + {'name': 'Blog posts API', + 'url': reverse('blog-posts-root', request)}, + {'name': 'Permissions example', + 'url': reverse('permissions-example', request)}, + {'name': 'Simple request mixin example', + 'url': reverse('request-example', request)} + ]) -- cgit v1.2.3 From 5fd4c639d7c64572dd07dc31dcd627bed9469b05 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 21 Feb 2012 20:57:36 +0000 Subject: Merge master into develop --- examples/sandbox/views.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'examples/sandbox') diff --git a/examples/sandbox/views.py b/examples/sandbox/views.py index 34216ad2..a9b82447 100644 --- a/examples/sandbox/views.py +++ b/examples/sandbox/views.py @@ -1,6 +1,6 @@ """The root view for the examples provided with Django REST framework""" -from djangorestframework.utils import reverse +from djangorestframework.reverse import reverse from djangorestframework.views import View from djangorestframework.response import Response -- cgit v1.2.3 From 1cde31c86d9423e9b7a7409c2ef2ba7c0500e47f Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Sat, 25 Feb 2012 18:45:17 +0000 Subject: Massive merge --- examples/sandbox/views.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'examples/sandbox') diff --git a/examples/sandbox/views.py b/examples/sandbox/views.py index a9b82447..f4de2947 100644 --- a/examples/sandbox/views.py +++ b/examples/sandbox/views.py @@ -19,7 +19,7 @@ class Sandbox(View): For example, to get the default representation using curl: bash: curl -X GET http://rest.ep.io/ - + Or, to get the plaintext documentation represention: bash: curl -X GET http://rest.ep.io/ -H 'Accept: text/plain' @@ -49,19 +49,19 @@ class Sandbox(View): def get(self, request): return Response([ {'name': 'Simple Resource example', - 'url': reverse('example-resource', request)}, + 'url': reverse('example-resource', request=request)}, {'name': 'Simple ModelResource example', - 'url': reverse('model-resource-root', request)}, + 'url': reverse('model-resource-root', request=request)}, {'name': 'Simple Mixin-only example', - 'url': reverse('mixin-view', request)}, - {'name': 'Object store API' - 'url': reverse('object-store-root', request)}, + 'url': reverse('mixin-view', request=request)}, + {'name': 'Object store API', + 'url': reverse('object-store-root', request=request)}, {'name': 'Code highlighting API', - 'url': reverse('pygments-root', request)}, + 'url': reverse('pygments-root', request=request)}, {'name': 'Blog posts API', - 'url': reverse('blog-posts-root', request)}, + 'url': reverse('blog-posts-root', request=request)}, {'name': 'Permissions example', - 'url': reverse('permissions-example', request)}, + 'url': reverse('permissions-example', request=request)}, {'name': 'Simple request mixin example', - 'url': reverse('request-example', request)} + 'url': reverse('request-example', request=request)} ]) -- cgit v1.2.3 From 372e945097f8e5e9ba3637eff84ee119c46c2276 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 24 Aug 2012 16:04:11 +0100 Subject: Fix broken example --- examples/sandbox/views.py | 2 -- 1 file changed, 2 deletions(-) (limited to 'examples/sandbox') diff --git a/examples/sandbox/views.py b/examples/sandbox/views.py index f4de2947..66622d0d 100644 --- a/examples/sandbox/views.py +++ b/examples/sandbox/views.py @@ -62,6 +62,4 @@ class Sandbox(View): 'url': reverse('blog-posts-root', request=request)}, {'name': 'Permissions example', 'url': reverse('permissions-example', request=request)}, - {'name': 'Simple request mixin example', - 'url': reverse('request-example', request=request)} ]) -- cgit v1.2.3 From eea2aa04378d27d79e7aba12ce95c697148bd57e Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 29 Aug 2012 19:54:38 +0100 Subject: Remove examples (to be moved to a seperate project) --- examples/sandbox/__init__.py | 0 examples/sandbox/views.py | 65 -------------------------------------------- 2 files changed, 65 deletions(-) delete mode 100644 examples/sandbox/__init__.py delete mode 100644 examples/sandbox/views.py (limited to 'examples/sandbox') diff --git a/examples/sandbox/__init__.py b/examples/sandbox/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/examples/sandbox/views.py b/examples/sandbox/views.py deleted file mode 100644 index 66622d0d..00000000 --- a/examples/sandbox/views.py +++ /dev/null @@ -1,65 +0,0 @@ -"""The root view for the examples provided with Django REST framework""" - -from djangorestframework.reverse import reverse -from djangorestframework.views import View -from djangorestframework.response import Response - - -class Sandbox(View): - """ - This is the sandbox for the examples provided with - [Django REST framework][1]. - - These examples are provided to help you get a better idea of some of the - features of RESTful APIs created using the framework. - - All the example APIs allow anonymous access, and can be navigated either - through the browser or from the command line. - - For example, to get the default representation using curl: - - bash: curl -X GET http://rest.ep.io/ - - Or, to get the plaintext documentation represention: - - bash: curl -X GET http://rest.ep.io/ -H 'Accept: text/plain' - - The examples provided: - - 1. A basic example using the [Resource][2] class. - 2. A basic example using the [ModelResource][3] class. - 3. An basic example using Django 1.3's [class based views][4] and - djangorestframework's [RendererMixin][5]. - 4. A generic object store API. - 5. A code highlighting API. - 6. A blog posts and comments API. - 7. A basic example using permissions. - 8. A basic example using enhanced request. - - Please feel free to browse, create, edit and delete the resources in - these examples. - - [1]: http://django-rest-framework.org - [2]: http://django-rest-framework.org/library/resource.html - [3]: http://django-rest-framework.org/library/modelresource.html - [4]: http://docs.djangoproject.com/en/dev/topics/class-based-views/ - [5]: http://django-rest-framework.org/library/renderers.html - """ - - def get(self, request): - return Response([ - {'name': 'Simple Resource example', - 'url': reverse('example-resource', request=request)}, - {'name': 'Simple ModelResource example', - 'url': reverse('model-resource-root', request=request)}, - {'name': 'Simple Mixin-only example', - 'url': reverse('mixin-view', request=request)}, - {'name': 'Object store API', - 'url': reverse('object-store-root', request=request)}, - {'name': 'Code highlighting API', - 'url': reverse('pygments-root', request=request)}, - {'name': 'Blog posts API', - 'url': reverse('blog-posts-root', request=request)}, - {'name': 'Permissions example', - 'url': reverse('permissions-example', request=request)}, - ]) -- cgit v1.2.3