diff --git a/docs/img/api-docs.gif b/docs/img/api-docs.gif new file mode 100644 index 000000000..6da560b7e Binary files /dev/null and b/docs/img/api-docs.gif differ diff --git a/docs/img/api-docs.png b/docs/img/api-docs.png new file mode 100644 index 000000000..939075a89 Binary files /dev/null and b/docs/img/api-docs.png differ diff --git a/docs/topics/3.6-announcement.md b/docs/topics/3.6-announcement.md index 43e87eda2..91c939ae0 100644 --- a/docs/topics/3.6-announcement.md +++ b/docs/topics/3.6-announcement.md @@ -24,7 +24,7 @@ The 3.6 release adds two major new features to REST framework. 1. Built-in interactive API documentation support. 2. A new JavaScript client library. -**TODO: Insert image** +![API Documentation](/img/api-docs.gif) *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: -**TODO: Image** +![API Documentation](/img/api-docs.png) 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 @@ -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. +--- + ## JavaScript client library 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 "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 diff --git a/rest_framework/static/rest_framework/docs/js/api.js b/rest_framework/static/rest_framework/docs/js/api.js index 8cd9807d2..58b28afae 100644 --- a/rest_framework/static/rest_framework/docs/js/api.js +++ b/rest_framework/static/rest_framework/docs/js/api.js @@ -211,7 +211,7 @@ $('form.authentication-token-form').submit(function(event) { 'scheme': scheme, 'token': token }; - $('#selected-authentication').text('header'); + $('#selected-authentication').text('token'); $('#auth-control').children().removeClass('active'); $('#auth-control').find("[data-auth='token']").addClass('active'); $('#auth_token_modal').modal('hide');