Fix docblocks for Authentication API endpoints #119
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
Contributor
joshcanhelp
commented
Jul 13, 2018
joshcanhelp
commented
- Update docs links
- More clear descriptions and param names
joshcanhelp
commented
Jul 13, 2018
| # @return [json] Returns the created user | ||
| def signup(email, password, connection_name = UP_AUTH) | ||
| raise Auth0::InvalidParameter, 'Must supply a valid email' if email.to_s.empty? | ||
| raise Auth0::InvalidParameter, 'Must supply a valid password' if password.to_s.empty? | ||
| request_params = { | ||
| client_id: @client_id, |
There was a problem hiding this comment.
Adjusted the order to match function params
joshcanhelp
commented
Jul 13, 2018
| def change_password(email, password, connection_name = UP_AUTH) | ||
| raise Auth0::InvalidParameter, 'Must supply a valid email' if email.to_s.empty? | ||
| request_params = { | ||
| client_id: @client_id, |
There was a problem hiding this comment.
Adjusted the order to match function params
joshcanhelp
commented
Jul 13, 2018
| def start_passwordless_email_flow(email, send = 'link', auth_params = {}) | ||
| raise Auth0::InvalidParameter, 'Must supply a valid email' if email.to_s.empty? | ||
| request_params = { | ||
| client_id: @client_id, |
There was a problem hiding this comment.
Adjusted the order to match function params
joshcanhelp
commented
Jul 13, 2018
| # @param phone_number [string] User's phone number. | ||
| def start_passwordless_sms_flow(phone_number) | ||
| raise Auth0::InvalidParameter, 'Must supply a valid phone number' if phone_number.to_s.empty? | ||
| request_params = { | ||
| client_id: @client_id, |
There was a problem hiding this comment.
Adjusted the order to match function params
joshcanhelp
force-pushed
the
add-auth-endpoints-docs
branch
2 times, most recently
from
f1a6749
to
333fc78
Compare
joshcanhelp
force-pushed
the
add-auth-endpoints-docs
branch
from
333fc78
to
3aa0fa4
Compare
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.