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

docs: update OAS of reset password routes (#11711)

Browse Source
This commit is contained in:
Shahed Nasser
2025-03-04 13:28:41 +02:00
committed by GitHub
parent 7dbec10b3b
commit c2e24b6cfd
6 changed files with 34 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
www/utils/generated/oas-output/base/admin.oas.base.yaml
View File

@@ -749,3 +749,8 @@ components:
in: cookie
name: connect.sid
x-displayName: Cookie Session ID
reset_password:
type: http
x-displayName: Reset Password Token
scheme: bearer
x-is-auth: false

5
www/utils/generated/oas-output/base/store.oas.base.yaml
View File

@@ -349,3 +349,8 @@ components:
x-displayName: Cookie Session ID
in: cookie
name: connect.sid
reset_password:
type: http
x-displayName: Reset Password Token
scheme: bearer
x-is-auth: false

15
www/utils/generated/oas-output/operations/admin/post_auth_[actor_type]_[auth_provider]_update.ts
View File

@@ -3,11 +3,11 @@
* operationId: PostActor_typeAuth_providerUpdate
* summary: Reset an Admin User's Password
* x-sidebar-summary: Reset Password
* description: Reset an admin user's password using a reset-password token generated with the [Generate Reset Password Token API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerresetpassword).
* description: Reset an admin user's password using a reset-password token generated with the [Generate Reset Password Token API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerresetpassword). You pass the token as a bearer token in the request's Authorization header.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#reset-password-route
* description: Learn more about this API route.
* x-authenticated: false
* x-authenticated: true
* parameters:
* - name: auth_provider
* in: path
@@ -16,12 +16,6 @@
* schema:
* type: string
* example: "emailpass"
* - name: token
* in: query
* description: The reset password token received using the Get Reset Password API route.
* required: true
* schema:
* type: string
* requestBody:
* content:
* application/json:
@@ -36,12 +30,15 @@
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/auth/user/emailpass/update?token=123' \
* curl -X POST '{backend_url}/auth/user/emailpass/update' \
* -H 'Content-Type: application/json' \
* -H 'Authorization: Bearer {token}' \
* --data-raw '{
* "email": "admin@medusa-test.com",
* "password": "supersecret"
* }'
* security:
* - reset_password: []
* tags:
* - Auth
* responses:

15
www/utils/generated/oas-output/operations/store/post_auth_[actor_type]_[auth_provider]_update.ts
View File

@@ -3,11 +3,11 @@
* operationId: PostActor_typeAuth_providerUpdate
* summary: Reset a Customer's Password
* x-sidebar-summary: Reset Password
* description: 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).
* description: 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). You pass the token as a bearer token in the request's Authorization header.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password#2-reset-password-page
* description: "Storefront development: How to create the reset password page."
* x-authenticated: false
* x-authenticated: true
* parameters:
* - name: auth_provider
* in: path
@@ -16,12 +16,6 @@
* schema:
* type: string
* example: "emailpass"
* - name: token
* in: query
* description: The reset password token received using the Get Reset Password API route.
* required: true
* schema:
* type: string
* requestBody:
* content:
* application/json:
@@ -36,12 +30,15 @@
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/auth/customer/emailpass/update?token=123' \
* curl -X POST '{backend_url}/auth/customer/emailpass/update' \
* -H 'Content-Type: application/json' \
* -H 'Authorization: Bearer {token}' \
* --data-raw '{
* "email": "customer@gmail.com",
* "password": "supersecret"
* }'
* security:
* - reset_password: []
* tags:
* - Auth
* responses: