Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document availability of request.auth.token in verifyFunc() #184

Closed
jmm opened this issue Aug 1, 2016 · 2 comments
Closed

Document availability of request.auth.token in verifyFunc() #184

jmm opened this issue Aug 1, 2016 · 2 comments

Comments

@jmm
Copy link
Contributor

jmm commented Aug 1, 2016

request.auth.token is set by the time verifyFunc() is invoked. Can that be documented? Current documentation only refers to it as being available after validation.

@nelsonic
Copy link
Member

Well spotted @jmm (again!) Documentation update?

@jmm
Copy link
Contributor Author

jmm commented Aug 23, 2016

Thanks! This...

The encoded JWT (token) is extracted from the headers of the request

...and all similar references should just say something to the effect of "extracted from the request", since additional token sources (cookie, URL) were added. (Technically reading it from a cookie is still extracting it from the headers, but for the purposes of these docs I think it's more helpful to treat headers and cookies as fundamentally different places to read the token from.) Same with references to the Authorization header, since the header to read from is configurable. I opened #190 for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants