Update documentation for validate_token #277
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `Usage TL;DR` section of README.md has documentation for `validate_token` that states that the method takes `id` and `auth_token` as params. However, the class where `validate_token` is defined (`TokenValidationsController`) includes a `:before_filter :set_user_by_token`, who's definition parses headers and query params for `access-token`, not `auth_token`. This commit updates the documentation to specify that `access-token` is an accepted param instead of `auth_token`.
|
Thanks! |
booleanbetrayal
added a commit
that referenced
this pull request
Jul 3, 2015
…mentation Update documentation for validate_token
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
Usage TL;DRsection of README.md has documentation forvalidate_tokenthat states that the method takesuidandauth_tokenas params. However, the class wherevalidate_tokenis defined (TokenValidationsController) includes a:before_filter :set_user_by_token, who's definition parses headers and query params foraccess-token, notauth_token. This commit updates the documentation to specify thataccess-tokenis an accepted param instead ofauth_token. This closes #270.