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

Custom auth should be documented a little more #98

Open
jazeee opened this issue Jul 1, 2015 · 2 comments
Open

Custom auth should be documented a little more #98

jazeee opened this issue Jul 1, 2015 · 2 comments

Comments

@jazeee
Copy link
Contributor

jazeee commented Jul 1, 2015

EDIT:
I was wrong about the original ticket.

** Deleted original request. **

I believe the documentation should describe the function signature, and what it expects as a response such as:

Restivus.configure 
  auth: 
    user:  ->
      token = @.request.headers["x-auth-token"]
      ... Do something with token and extract your user...
      if notAllowed(user) throw new Meteor.Error("Unauthorized")
      return user
@jazeee jazeee changed the title Complete auth should work Complete auth should be documented a little more Jul 1, 2015
@jazeee
Copy link
Contributor Author

jazeee commented Jul 1, 2015

Sorry, I misunderstood how the Complete Auth works. I do believe a little more documentation will help with understanding.

@kahmali
Copy link
Owner

kahmali commented Jul 1, 2015

I agree that the auth section of the docs needs some improvement. I made a small update for #91, but the custom auth needs to be explained there as well. I'll keep this open until it's updated.

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