Update documentation for HashPasswordChange #842
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
Provide clearer pseudo-code, which reflects the removal of Ash.Changeset.new/2 and shows the interaction between arguments and the `change` in the Resource.DSL
jimsynz
requested changes
Jan 15, 2025
There was a problem hiding this comment.
Hi @LannyBose 👋
Thanks for the contribution. Unfortunately they're not quite right. If you can update your PR I'll be happy to merge it, otherwise I'll swing back in a day or two and make the changes myself.
Comment on lines
-14
to
-17
| Changeset.new(user, %{}) | ||
| |> Changeset.set_context(%{strategy_name: :password}) | ||
| |> Changeset.for_update(:update, params) | ||
| |> Accounts.update() |
There was a problem hiding this comment.
You're right that Ash.Changeset.new/2 is gone, however the rest of your example is incorrect.
It should probably be more like:
Changeset.new(user)
|> Changeset.set_context(%{strategy_name: :password})
|> Changeset.for_update(:change_password, params)
|> Accounts.update()| @@ -30,6 +32,8 @@ defmodule AshAuthentication.Strategy.Password.HashPasswordChange do | |||
|
|
|||
| ```elixir | |||
| update :change_password do | |||
| argument :your_unencrypted_password_field, :string, sensitive?: true | |||
|
|
|||
| change {AshAuthentication.Strategy.Password.HashPasswordChange, strategy_name: :password} | |||
There was a problem hiding this comment.
I think that these examples should be updated to match the action that the add strategy igniter generates.
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.
When referencing how to make a manual password change, I felt the included documentation could use some sprucing up.
Changes include:
Ash.Changeset.new/2seems to be goneset_contextdidn't work as expected when handed toHashPasswordChange.change. It kept resulting inBadMapErrorupdateResource DSLIt's very possible my first chunk of code isn't idiomatic, but it did work. Happy to receive adjusting feedback there!