diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-guide/authentication.md | 8 | ||||
| -rw-r--r-- | docs/css/default.css | 11 | ||||
| -rw-r--r-- | docs/index.md | 4 | ||||
| -rw-r--r-- | docs/template.html | 31 | ||||
| -rw-r--r-- | docs/topics/contributing.md | 2 | ||||
| -rw-r--r-- | docs/topics/release-notes.md | 6 | 
6 files changed, 58 insertions, 4 deletions
diff --git a/docs/api-guide/authentication.md b/docs/api-guide/authentication.md index 541c6575..0eea31d7 100644 --- a/docs/api-guide/authentication.md +++ b/docs/api-guide/authentication.md @@ -119,6 +119,8 @@ To use the `TokenAuthentication` scheme, include `rest_framework.authtoken` in y          ...          'rest_framework.authtoken'      ) +     +Make sure to run `manage.py syncdb` after changing your settings.  You'll also need to create tokens for your users. @@ -140,6 +142,10 @@ Unauthenticated responses that are denied permission will result in an `HTTP 401      WWW-Authenticate: Token +The `curl` command line tool may be useful for testing token authenticated APIs.  For example: + +    curl -X GET http://127.0.0.1:8000/api/example/ -H 'Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b' +  ---  **Note:** If you use `TokenAuthentication` in production you must ensure that your API is only available over `https` only. @@ -294,7 +300,7 @@ The only thing needed to make the `OAuth2Authentication` class work is to insert  The command line to test the authentication looks like: -    curl -H "Authorization: Bearer <your-access-token>" http://localhost:8000/api/?client_id=YOUR_CLIENT_ID\&client_secret=YOUR_CLIENT_SECRET +    curl -H "Authorization: Bearer <your-access-token>" http://localhost:8000/api/  --- diff --git a/docs/css/default.css b/docs/css/default.css index c160b63d..173d70e0 100644 --- a/docs/css/default.css +++ b/docs/css/default.css @@ -277,3 +277,14 @@ footer a {  footer a:hover {    color: gray;  } + +.btn-inverse { +  background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#606060), to(#404040)) !important; +  background-image: -webkit-linear-gradient(top, #606060, #404040) !important; +} + +.modal-open .modal,.btn:focus{outline:none;} + +@media (max-width: 650px) { +  .repo-link.btn-inverse {display: none;} +} diff --git a/docs/index.md b/docs/index.md index 5357536d..4c2720c8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,9 +9,9 @@  # Django REST framework -**Web APIs for Django, made easy.** +**Awesome web-browseable Web APIs.** -Django REST framework is a flexible, powerful library that makes it incredibly easy to build Web APIs.  It is designed as a modular and easy to customize architecture, based on Django's class based views. +Django REST framework is a flexible, powerful Web API toolkit.  It is designed as a modular and easy to customize architecture, based on Django's class based views.  APIs built using REST framework are fully self-describing and web browseable - a huge useability win for your developers.  It also supports a wide range of media types, authentication and permission policies out of the box. diff --git a/docs/template.html b/docs/template.html index 3e0f29aa..7e929762 100644 --- a/docs/template.html +++ b/docs/template.html @@ -41,6 +41,9 @@        <div class="navbar-inner">          <div class="container-fluid">              <a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/master">GitHub</a> +            <a class="repo-link btn btn-inverse btn-small {{ next_url_disabled }}" href="{{ next_url }}">Next <i class="icon-arrow-right icon-white"></i></a> +            <a class="repo-link btn btn-inverse btn-small {{ prev_url_disabled }}" href="{{ prev_url }}"><i class="icon-arrow-left icon-white"></i> Previous</a> +            <a class="repo-link btn btn-inverse btn-small" href="#searchModal" data-toggle="modal"><i class="icon-search icon-white"></i> Search</a>            <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">              <span class="icon-bar"></span>              <span class="icon-bar"></span> @@ -118,6 +121,34 @@      <div class="body-content">        <div class="container-fluid"> + +<!-- Search Modal --> +<div id="searchModal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true"> +  <div class="modal-header"> +    <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> +    <h3 id="myModalLabel">Documentation search</h3> +  </div> +  <div class="modal-body"> +    <!-- Custom google search --> +    <script> +      (function() { +        var cx = '015016005043623903336:rxraeohqk6w'; +        var gcse = document.createElement('script'); +        gcse.type = 'text/javascript'; +        gcse.async = true; +        gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + +            '//www.google.com/cse/cse.js?cx=' + cx; +        var s = document.getElementsByTagName('script')[0]; +        s.parentNode.insertBefore(gcse, s); +      })(); +    </script> +    <gcse:search></gcse:search> +  </div> +  <div class="modal-footer"> +    <button class="btn" data-dismiss="modal" aria-hidden="true">Close</button> +  </div> +</div> +          <div class="row-fluid">            <div class="span3"> diff --git a/docs/topics/contributing.md b/docs/topics/contributing.md index a13f4461..1d1fe892 100644 --- a/docs/topics/contributing.md +++ b/docs/topics/contributing.md @@ -18,7 +18,7 @@ When answering questions make sure to help future contributors find their way ar  # Issues -Usage questions should be directed to the [discussion group][google-group].  Feature requests, bug reports and other issues should be raised on the GitHub [issue tracker][issues]. +It's really helpful if you make sure you address issues to the correct channel.  Usage questions should be directed to the [discussion group][google-group].  Feature requests, bug reports and other issues should be raised on the GitHub [issue tracker][issues].  Some tips on good issue reporting: diff --git a/docs/topics/release-notes.md b/docs/topics/release-notes.md index e63aee49..62c31358 100644 --- a/docs/topics/release-notes.md +++ b/docs/topics/release-notes.md @@ -40,6 +40,12 @@ You can determine your currently installed version using `pip freeze`:  ## 2.2.x series +### Master + +* OAuth2 authentication no longer requires unneccessary URL parameters in addition to the token. +* URL hyperlinking in browseable API now handles more cases correctly. +* Bugfix: Fix regression with DjangoFilterBackend not worthing correctly with single object views. +  ### 2.2.5  **Date**: 26th March 2013  | 
