lynndylanhurley / lynndylanhurley/devise_token_auth

update documentation is really unclear

Open
#401 4 comments 1 reaction 0 assignees View on GitHub
Dominant language
Ruby
Stars
3.6k
Forks
1.1k
PR merge metrics
No merged PRs in 30d

Description

From the api documentation for PUT to /auth

`Account updates. This route will update an existing user's account settings. The default accepted params are password and password_confirmation, but this can be customized using the devise_parameter_sanitizer system. If config.check_current_password_before_update is set to :attributes the current_password param is checked before any update, if it is set to :password the current_password param is checked only if the request updates user password.`

This seems to imply that only password and password_confirmation are needed which can't be true since no unique identifier is passed through in the route.

I seem to get a 404 when passing through an email as opposed to a 422 when passing through a uid or id which makes me think it wants an email as opposed to those other things but I am passing through a valid email and no records are returned. I have tried passing through email with various combos of password and password_confirmation but nothing seems to work.

A more straightforward description possibly including example json would be extremely helpful.

Contributor guide

Open the contributing guide

Research direction

Read the API documentation for PUT /auth and reproduce the reported requests using email, uid, and id with the documented password parameters. Clarify which identifier and parameters are required, explain the 404 and 422 outcomes if confirmed, and add straightforward example JSON showing a successful update.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
api, authentication, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.