Merge pull request #5362 from ashishnitinpatil/master

~api-clients documentation: installation code fix
This commit is contained in:
Xavier Ordoquy 2017-08-24 13:16:14 +02:00 committed by GitHub
commit 1c4d277f53

View File

@ -419,7 +419,7 @@ The `SessionAuthentication` class allows session cookies to provide the user
authentication. You'll want to provide a standard HTML login flow, to allow authentication. You'll want to provide a standard HTML login flow, to allow
the user to login, and then instantiate a client using session authentication: the user to login, and then instantiate a client using session authentication:
let auth = coreapi.auth.SessionAuthentication({ let auth = new coreapi.auth.SessionAuthentication({
csrfCookieName: 'csrftoken', csrfCookieName: 'csrftoken',
csrfHeaderName: 'X-CSRFToken' csrfHeaderName: 'X-CSRFToken'
}) })
@ -433,7 +433,7 @@ requests for unsafe HTTP methods.
The `TokenAuthentication` class can be used to support REST framework's built-in The `TokenAuthentication` class can be used to support REST framework's built-in
`TokenAuthentication`, as well as OAuth and JWT schemes. `TokenAuthentication`, as well as OAuth and JWT schemes.
let auth = coreapi.auth.TokenAuthentication({ let auth = new coreapi.auth.TokenAuthentication({
scheme: 'JWT' scheme: 'JWT'
token: '<token>' token: '<token>'
}) })
@ -471,7 +471,7 @@ For example, using the "Django REST framework JWT" package
The `BasicAuthentication` class can be used to support HTTP Basic Authentication. The `BasicAuthentication` class can be used to support HTTP Basic Authentication.
let auth = coreapi.auth.BasicAuthentication({ let auth = new coreapi.auth.BasicAuthentication({
username: '<username>', username: '<username>',
password: '<password>' password: '<password>'
}) })