docs: fix authentication callback descriptions to include all query parameters (#10932)

This commit is contained in:
Shahed Nasser
2025-01-13 15:12:06 +02:00
committed by GitHub
parent 55ff7e4dcd
commit 4250c292eb
18 changed files with 178 additions and 188 deletions
@@ -3,10 +3,8 @@
* operationId: PostActor_typeAuth_providerCallback
* summary: Validate Authentication Callback
* description: >
* This API route is used by your dashboard or frontend application when a third-party provider redirects to it after authentication.
*
*
* It validates the authentication with the third-party provider and, if successful, returns an authentication token.
* This API route is used by your dashboard or frontend application when a third-party provider redirects to it after authentication. It validates the authentication with the third-party provider and, if successful, returns an authentication token.
* All query parameters received from the third-party provider, such as `code`, `state`, and `error`, must be passed as query parameters to this route.
*
*
* You can decode the JWT token using libraries like [react-jwt](https://www.npmjs.com/package/react-jwt) in the frontend. If the decoded data doesn't
@@ -3,11 +3,8 @@
* operationId: PostActor_typeAuth_providerCallback
* summary: Validate Authentication Callback
* description: >
* This API route is used by your storefront or frontend application when a third-party provider redirects to it after authentication.
*
*
* It validates the authentication with the third-party provider and, if successful, returns an authentication token.
*
* This API route is used by your storefront or frontend application when a third-party provider redirects to it after authentication. It validates the authentication with the third-party provider and, if successful, returns an authentication token.
* All query parameters received from the third-party provider, such as `code`, `state`, and `error`, must be passed as query parameters to this route.
*
* You can decode the JWT token using libraries like [react-jwt](https://www.npmjs.com/package/react-jwt) in the storefront. If the decoded data doesn't
* have an `actor_id` property, then you must register the customer using the Create Customer API route passing the token in the request's Authorization header.