asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: add more clarification to reset password in API reference (#11695)

Browse Source
This commit is contained in:
Shahed Nasser
2025-03-03 18:09:03 +02:00
committed by GitHub
parent 92514885e4
commit 40a9cffb34
11 changed files with 58 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_reset-password.yaml
View File

@@ -3,13 +3,22 @@ post:
summary: Generate Reset Password Token for Customer
x-sidebar-summary: Generate Reset Password Token
description: >
Generate a reset password token for a customer. This API route emits the
`auth.password_reset` event, passing it the token as a payload. You can
listen to that event and send the user a notification. The notification
should have a URL that accepts a `token` query parameter.
Generate a reset password token for a customer. This API route doesn't reset
the customer password or send them the reset instructions in a notification.
Use the generated token to update the user's password using the Reset Password API route.
Instead, This API route emits the `auth.password_reset` event, passing it
the token as a payload. You can listen to that event in a subscriber as
explained in [this
guide](https://docs.medusajs.com/resources/commerce-modules/auth/reset-password),
then send the customer a notification. The notification is sent using a
[Notification Module
Provider](https://docs.medusajs.com/resources/architectural-modules/notification),
and it should have a URL that accepts a `token` query parameter, allowing
the customer to reset their password from the storefront.
Use the generated token to update the customer's password using the [Reset Password API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerupdate).
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password#1-request-reset-password-page

5
www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_update.yaml
View File

@@ -3,8 +3,9 @@ post:
summary: Reset a Customer's Password
x-sidebar-summary: Reset Password
description: >-
Reset a customer's password. Generate the reset password token first using
the Get Reset Password Token API route.
Reset a customer's password using a reset-password token generated with the
[Generate Reset Password Token API
route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerresetpassword).
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password#2-reset-password-page