chore(docs): Generated API Reference (#5431)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-10-20 14:13:44 +03:00
committed by GitHub
parent 9dcd62c731
commit da05999f13
20 changed files with 36 additions and 32 deletions

View File

@@ -2,7 +2,7 @@ get:
operationId: GetCustomersCustomerPaymentMethods
summary: Get Saved Payment Methods
description: >-
Retrieve the logged-in customer's saved payment methods. This endpoint only
Retrieve the logged-in customer's saved payment methods. This API Route only
works with payment providers created with the deprecated Payment Service
interface. The payment methods are saved using the Payment Service's
third-party service, and not on the Medusa backend. So, they're retrieved

View File

@@ -3,7 +3,7 @@ post:
summary: Reset Password
description: >-
Reset a Customer's password using a password token created by a previous
request to the Request Password Reset endpoint. If the password token
request to the Request Password Reset API Route. If the password token
expired, you must create a new one.
externalDocs:
description: How to reset password

View File

@@ -2,8 +2,8 @@ post:
operationId: PostCustomersCustomerPasswordToken
summary: Request Password Reset
description: >-
Create a reset password token to be used in a subsequent Reset Password
endpoint. This emits the event `customer.password_reset`. If a notification
Create a reset password token to be used in a subsequent Reset Password API
Route. This emits the event `customer.password_reset`. If a notification
provider is installed in the Medusa backend and is configured to handle this
event, a notification to the customer, such as an email, may be sent with
reset instructions.

View File

@@ -4,7 +4,7 @@ post:
description: >-
Complete an Order Edit and reflect its changes on the original order. Any
additional payment required must be authorized first using the Payment
Collection endpoints.
Collection API Routes.
externalDocs:
description: How to handle order edits in a storefront
url: https://docs.medusajs.com/modules/orders/storefront/handle-order-edits

View File

@@ -4,7 +4,7 @@ post:
description: >-
Allow the logged-in customer to claim ownership of one or more orders. This
generates a token that can be used later on to verify the claim using the
endpoint Verify Order Claim. This also emits the event
Verify Order Claim API Route. This also emits the event
`order-update-token.created`. So, if you have a notification provider
installed that handles this event and sends the customer a notification,
such as an email, the customer should receive instructions on how to

View File

@@ -4,7 +4,7 @@ get:
description: >-
Retrieve a list of product categories. The product categories can be
filtered by fields such as `handle` or `q`. The product categories can also
be paginated. This endpoint can also be used to retrieve a product category
be paginated. This API Route can also be used to retrieve a product category
by its handle.
x-featureFlag: product_categories
externalDocs:

View File

@@ -5,7 +5,7 @@ get:
Retrieves a list of products. The products can be filtered by fields such as
`id` or `q`. The products can also be sorted or paginated.
This endpoint can also be used to retrieve a product by its handle.
This API Route can also be used to retrieve a product by its handle.
For accurate and correct pricing of the products based on the customer's

View File

@@ -3,7 +3,7 @@ get:
summary: List Regions
description: >-
Retrieve a list of regions. The regions can be filtered by fields such as
`created_at`. The regions can also be paginated. This endpoint is useful to
`created_at`. The regions can also be paginated. This API Route is useful to
show the customer all available regions to choose from.
externalDocs:
description: How to use regions in a storefront

View File

@@ -6,8 +6,8 @@ post:
with the swap. If a return shipping option is specified, the return will
automatically be fulfilled.
To complete the swap, you must use the Complete Cart endpoint passing it the
ID of the swap's cart.
To complete the swap, you must use the Complete Cart API Route passing it
the ID of the swap's cart.
An idempotency key will be generated if none is provided in the header