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

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductReq.yaml

@@ -17,7 +17,7 @@ properties:
   images:
     description: >-
       An array of images of the Product. Each value in the array is a URL to the
-      image. You can use the upload endpoints to upload the image and obtain a
+      image. You can use the upload API Routes to upload the image and obtain a
       URL.
     type: array
     items:
@@ -25,7 +25,8 @@ properties:
   thumbnail:
     description: >-
       The thumbnail to use for the Product. The value is a URL to the thumbnail.
-      You can use the upload endpoints to upload the thumbnail and obtain a URL.
+      You can use the upload API Routes to upload the thumbnail and obtain a
+      URL.
     type: string
   handle:
     description: >-

www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsReq.yaml

@@ -27,7 +27,7 @@ properties:
   images:
     description: >-
       An array of images of the Product. Each value in the array is a URL to the
-      image. You can use the upload endpoints to upload the image and obtain a
+      image. You can use the upload API Routes to upload the image and obtain a
       URL.
     type: array
     items:
@@ -35,7 +35,8 @@ properties:
   thumbnail:
     description: >-
       The thumbnail to use for the Product. The value is a URL to the thumbnail.
-      You can use the upload endpoints to upload the thumbnail and obtain a URL.
+      You can use the upload API Routes to upload the thumbnail and obtain a
+      URL.
     type: string
   handle:
     description: >-

www/apps/api-reference/specs/admin/openapi.yaml

@@ -13,8 +13,8 @@ tags:
       that, they can create an Oauth provider within the plugin that handles the
       authentication.
 
-      The Apps Oauth API Routes allows admins to manage and generate token for an
+      The Apps Oauth API Routes allows admins to manage and generate token for
-      app using its oauth provider.
+      an app using its oauth provider.
   - name: Auth
     description: >
       Authentication API Routes allow admin users to manage their session, such
@@ -41,8 +41,8 @@ tags:
       A store can use unlimited currencies, and each region must be associated
       with at least one currency.
 
-      Currencies are defined within the Medusa backend. Currency API Routes allow
+      Currencies are defined within the Medusa backend. Currency API Routes
-      admins to list and update currencies.
+      allow admins to list and update currencies.
     externalDocs:
       description: How to manage currencies
       url: >-

www/apps/api-reference/specs/admin/paths/admin_auth.yaml

@@ -93,7 +93,7 @@ delete:
     Delete the current session for the logged in user. This will only work if
     you're using Cookie session for authentication. If the API token is still
     passed in the header, the user is still authorized to perform admin
-    functionalities in other endpoints.
+    functionalities in other API Routes.
   x-codegen:
     method: deleteSession
   x-codeSamples:

www/apps/api-reference/specs/admin/paths/admin_batch-jobs.yaml

@@ -270,7 +270,7 @@ post:
   description: >-
     Create a Batch Job to be executed asynchronously in the Medusa backend. If
     `dry_run` is set to `true`, the batch job will not be executed until the it
-    is confirmed, which can be done using the Confirm Batch Job endpoint.
+    is confirmed, which can be done using the Confirm Batch Job API Route.
   externalDocs:
     description: How to create a batch job
     url: https://docs.medusajs.com/development/batch-jobs/create#create-batch-job

www/apps/api-reference/specs/admin/paths/admin_batch-jobs_{id}_confirm.yaml

@@ -3,7 +3,7 @@ post:
   summary: Confirm a Batch Job
   description: >-
     When a batch job is created, it is not executed automatically if `dry_run`
-    is set to `true`. This endpoint confirms that the batch job should be
+    is set to `true`. This API Route confirms that the batch job should be
     executed.
   x-authenticated: true
   parameters:

www/apps/api-reference/specs/admin/paths/admin_products.yaml

@@ -281,7 +281,7 @@ post:
   summary: Create a Product
   x-authenticated: true
   description: >-
-    Create a new Product. This endpoint can also be used to create a gift card
+    Create a new Product. This API Route can also be used to create a gift card
     if the `is_giftcard` field is set to `true`.
   requestBody:
     content:

www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerAcceptClaimReq.yaml

@@ -3,5 +3,7 @@ required:
   - token
 properties:
   token:
-    description: The claim token generated by previous request to the Claim Order endpoint.
+    description: >-
+      The claim token generated by previous request to the Claim Order API
+      Route.
     type: string

www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReq.yaml

@@ -24,7 +24,7 @@ properties:
         reason_id:
           description: >-
             The ID of the return reason. Return reasons can be retrieved from
-            the List Return Reasons endpoint.
+            the List Return Reasons API Route.
           type: string
         note:
           description: A note to add to the item returned.

www/apps/api-reference/specs/store/components/schemas/StorePostSwapsReq.yaml

@@ -25,7 +25,7 @@ properties:
         reason_id:
           description: >-
             The ID of the reason of this return. Return reasons can be retrieved
-            from the List Return Reasons endpoint.
+            from the List Return Reasons API Route.
           type: string
         note:
           description: The note to add to the item being swapped.

www/apps/api-reference/specs/store/openapi.yaml

@@ -49,8 +49,8 @@ tags:
     description: >
       Orders are purchases made by customers, typically through a storefront.
 
-      Orders are placed and created using the Carts API Routes. The Orders
+      Orders are placed and created using the Carts API Routes. The Orders API
-      API Routes allow retrieving and claiming orders.
+      Routes allow retrieving and claiming orders.
     externalDocs:
       description: How to retrieve order details in a storefront
       url: >-
@@ -75,8 +75,8 @@ tags:
       cards](https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards)
       in a store.
 
-      Using these API Routes, you can filter products by categories, collections,
+      Using these API Routes, you can filter products by categories,
-      sales channels, and more.
+      collections, sales channels, and more.
     externalDocs:
       description: How to show products in a storefront
       url: https://docs.medusajs.com/modules/products/storefront/show-products
@@ -100,8 +100,8 @@ tags:
       such as marketing or discount purposes. For example, you can create a
       Summer Collection.
 
-      Using these API Routes, you can list or retrieve a collection's details and
+      Using these API Routes, you can list or retrieve a collection's details
-      products.
+      and products.
   - name: Product Tags
     description: |
       Product tags are string values that can be used to filter products by.

www/apps/api-reference/specs/store/paths/store_customers_me_payment-methods.yaml

@@ -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

www/apps/api-reference/specs/store/paths/store_customers_password-reset.yaml

@@ -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

www/apps/api-reference/specs/store/paths/store_customers_password-token.yaml

@@ -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
+    Create a reset password token to be used in a subsequent Reset Password API
-    endpoint. This emits the event `customer.password_reset`. If a notification
+    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.

www/apps/api-reference/specs/store/paths/store_order-edits_{id}_complete.yaml

@@ -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

www/apps/api-reference/specs/store/paths/store_orders_batch_customer_token.yaml

@@ -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

www/apps/api-reference/specs/store/paths/store_product-categories.yaml

@@ -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:

www/apps/api-reference/specs/store/paths/store_products.yaml

@@ -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

www/apps/api-reference/specs/store/paths/store_regions.yaml

@@ -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

www/apps/api-reference/specs/store/paths/store_swaps.yaml

@@ -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
+    To complete the swap, you must use the Complete Cart API Route passing it
-    ID of the swap's cart.
+    the ID of the swap's cart.
 
 
     An idempotency key will be generated if none is provided in the header