encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-02 03:13:18 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update JS constructor syntax (#5332)

Browse Source 
Fixes #5247
This commit is contained in:
Carlton Gibson 2017-08-15 15:33:06 +02:00 committed by Tom Christie
parent bf4b3ff0d5
commit 3110635685
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/topics/api-clients.md
View File

@ -408,7 +408,7 @@ The `coreapi` library, and the `schema` object will now both be available on the
In order to interact with the API you'll need a client instance. In order to interact with the API you'll need a client instance.
var client = coreapi.Client() var client = new coreapi.Client()
Typically you'll also want to provide some authentication credentials when Typically you'll also want to provide some authentication credentials when
instantiating the client. instantiating the client.
@ -423,7 +423,7 @@ the user to login, and then instantiate a client using session authentication:
csrfCookieName: 'csrftoken', csrfCookieName: 'csrftoken',
csrfHeaderName: 'X-CSRFToken' csrfHeaderName: 'X-CSRFToken'
}) })
let client = coreapi.Client({auth: auth}) let client = new coreapi.Client({auth: auth})
The authentication scheme will handle including a CSRF header in any outgoing The authentication scheme will handle including a CSRF header in any outgoing
requests for unsafe HTTP methods. requests for unsafe HTTP methods.
@ -437,7 +437,7 @@ The `TokenAuthentication` class can be used to support REST framework's built-in
scheme: 'JWT' scheme: 'JWT'
token: '<token>' token: '<token>'
}) })
let client = coreapi.Client({auth: auth}) let client = new coreapi.Client({auth: auth})
When using TokenAuthentication you'll probably need to implement a login flow When using TokenAuthentication you'll probably need to implement a login flow
using the CoreAPI client. using the CoreAPI client.
@ -448,7 +448,7 @@ request to an "obtain token" endpoint
For example, using the "Django REST framework JWT" package For example, using the "Django REST framework JWT" package
// Setup some globally accessible state // Setup some globally accessible state
window.client = coreapi.Client() window.client = new coreapi.Client()
window.loggedIn = false window.loggedIn = false
function loginUser(username, password) { function loginUser(username, password) {
@ -475,7 +475,7 @@ The `BasicAuthentication` class can be used to support HTTP Basic Authentication
username: '<username>', username: '<username>',
password: '<password>' password: '<password>'
}) })
let client = coreapi.Client({auth: auth}) let client = new coreapi.Client({auth: auth})
## Using the client ## Using the client