Finalizing release

This commit is contained in:
Tom Christie 2017-03-09 14:29:57 +00:00
parent d34b69d6f6
commit 5100a54e3d
4 changed files with 6 additions and 4 deletions

BIN
docs/img/api-docs.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 MiB

BIN
docs/img/api-docs.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 158 KiB

View File

@ -24,7 +24,7 @@ The 3.6 release adds two major new features to REST framework.
1. Built-in interactive API documentation support. 1. Built-in interactive API documentation support.
2. A new JavaScript client library. 2. A new JavaScript client library.
**TODO: Insert image** ![API Documentation](/img/api-docs.gif)
*Above: The interactive API documentation.* *Above: The interactive API documentation.*
@ -74,7 +74,7 @@ To install the API documentation, you'll need to include it in your projects URL
Once installed you should see something a little like this: Once installed you should see something a little like this:
**TODO: Image** ![API Documentation](/img/api-docs.png)
We'll likely be making further refinements to the API documentation over the We'll likely be making further refinements to the API documentation over the
coming weeks. Keep in mind that this is a new feature, and please do give coming weeks. Keep in mind that this is a new feature, and please do give
@ -82,6 +82,8 @@ us feedback if you run into any issues or limitations.
For more information on documenting your API endpoints see the ["Documenting your API"][api-docs] section. For more information on documenting your API endpoints see the ["Documenting your API"][api-docs] section.
---
## JavaScript client library ## JavaScript client library
The JavaScript client library allows you to load an API schema, and then interact The JavaScript client library allows you to load an API schema, and then interact
@ -150,7 +152,7 @@ For more information see the [Python client library documentation][py-docs].
The 3.5 "pending deprecation" of router arguments for generating a schema view, such as `schema_title`, `schema_url` and `schema_renderers`, have now been escalated to a The 3.5 "pending deprecation" of router arguments for generating a schema view, such as `schema_title`, `schema_url` and `schema_renderers`, have now been escalated to a
"deprecated" warning. "deprecated" warning.
Instead of using DefaultRouter(schema_title='Example API'), you should use the get_schema_view() function, and include the view explicitly in your URL conf. Instead of using `DefaultRouter(schema_title='Example API')`, you should use the `get_schema_view()` function, and include the view explicitly in your URL conf.
### DjangoFilterBackend ### DjangoFilterBackend

View File

@ -211,7 +211,7 @@ $('form.authentication-token-form').submit(function(event) {
'scheme': scheme, 'scheme': scheme,
'token': token 'token': token
}; };
$('#selected-authentication').text('header'); $('#selected-authentication').text('token');
$('#auth-control').children().removeClass('active'); $('#auth-control').children().removeClass('active');
$('#auth-control').find("[data-auth='token']").addClass('active'); $('#auth-control').find("[data-auth='token']").addClass('active');
$('#auth_token_modal').modal('hide'); $('#auth_token_modal').modal('hide');