chore(docs): Updated API Reference (automated) (#14470)

* chore(docs): Generated API Reference (automated)

* fixes

* fix locale header

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>

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

@@ -37,12 +37,22 @@ post:
       application/json:
         schema:
           type: object
-          title: identifier
-          description: >-
-            The customer's identifier for the selected auth provider. For
-            example, for the `emailpass` auth provider, the value is the
-            customer's email.
-          example: customer@gmail.com
+          description: The input data necessary to generate a reset password token.
+          required:
+            - identifier
+          properties:
+            identifier:
+              type: string
+              description: >-
+                The customer's identifier for the selected auth provider. For
+                example, for the `emailpass` auth provider, the value is the
+                customer's email.
+              example: customer@gmail.com
+            metadata:
+              type: object
+              description: >-
+                Optional metadata to include with the reset password token
+                generation request.
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK
@@ -80,6 +90,7 @@ post:
           entity_id, // The identifier of the user or customer. For example, an email address.
           actor_type, // The type of actor. For example, "customer", "user", or custom.
           token, // The generated token.
+          metadata, // Optional custom metadata passed from the request.
         }
         ```
       description: >-

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

@@ -12,7 +12,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml

@@ -20,7 +20,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false
@@ -116,7 +116,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

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

@@ -22,7 +22,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_carts_{id}_customer.yaml

@@ -26,7 +26,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml

@@ -23,7 +23,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml

@@ -29,7 +29,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false
@@ -169,7 +169,7 @@ delete:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml

@@ -23,7 +23,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false
@@ -120,7 +120,7 @@ delete:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml

@@ -25,7 +25,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml

@@ -19,7 +19,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

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

@@ -18,7 +18,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false
@@ -363,6 +363,7 @@ get:
             type: boolean
             title: $exists
             description: Filter by whether a value for this parameter exists (not `null`).
+        title: created_at
     - name: updated_at
       in: query
       description: Filter by the collection's update date.
@@ -632,6 +633,7 @@ get:
             type: boolean
             title: $exists
             description: Filter by whether a value for this parameter exists (not `null`).
+        title: updated_at
     - name: handle
       in: query
       required: false

www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml

@@ -24,7 +24,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

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

@@ -14,7 +14,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml

@@ -20,7 +20,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

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

@@ -19,7 +19,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

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

@@ -19,7 +19,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false
@@ -118,7 +118,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

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

@@ -20,7 +20,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false
@@ -203,7 +203,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml

@@ -21,7 +21,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false
@@ -128,7 +128,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false
@@ -243,7 +243,7 @@ delete:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

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

@@ -17,7 +17,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

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

@@ -15,7 +15,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml

@@ -20,7 +20,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_accept.yaml

@@ -26,7 +26,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_cancel.yaml

@@ -23,7 +23,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_decline.yaml

@@ -22,7 +22,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_request.yaml

@@ -23,7 +23,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_payment-collections.yaml

@@ -18,7 +18,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml

@@ -43,7 +43,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_payment-providers.yaml

@@ -18,7 +18,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

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

@@ -19,7 +19,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false
@@ -460,6 +460,7 @@ get:
             type: boolean
             title: $exists
             description: Filter by whether a value for this parameter exists (not `null`).
+        title: created_at
     - name: updated_at
       in: query
       description: Filter by the category's update date.
@@ -729,6 +730,7 @@ get:
             type: boolean
             title: $exists
             description: Filter by whether a value for this parameter exists (not `null`).
+        title: updated_at
     - name: $and
       in: query
       required: false

www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml

@@ -24,7 +24,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

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

@@ -14,7 +14,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false
@@ -413,6 +413,7 @@ get:
             type: boolean
             title: $exists
             description: Filter by whether a value for this parameter exists (not `null`).
+        title: created_at
     - name: updated_at
       in: query
       description: Filter by the tag's update date.
@@ -682,6 +683,7 @@ get:
             type: boolean
             title: $exists
             description: Filter by whether a value for this parameter exists (not `null`).
+        title: updated_at
     - name: with_deleted
       in: query
       description: Whether to include deleted records in the result.

www/apps/api-reference/specs/store/paths/store_product-tags_{id}.yaml

@@ -20,7 +20,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

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

@@ -14,7 +14,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false
@@ -410,6 +410,7 @@ get:
             type: boolean
             title: $exists
             description: Filter by whether a value for this parameter exists (not `null`).
+        title: created_at
     - name: updated_at
       in: query
       description: Filter by the type's update date.
@@ -679,6 +680,7 @@ get:
             type: boolean
             title: $exists
             description: Filter by whether a value for this parameter exists (not `null`).
+        title: updated_at
     - name: with_deleted
       in: query
       description: Whether to include deleted records in the result.

www/apps/api-reference/specs/store/paths/store_product-types_{id}.yaml

@@ -20,7 +20,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

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

@@ -8,9 +8,9 @@ get:
 
     You can retrieve the content of the products translated to a specific locale
     either by passing the `locale` query parameter or by setting the
-    `Content-Language` header to the desired locale code in BCP 47 format. If
-    you don't pass a locale, and your store has a default locale, the default
-    locale will be used.
+    `x-medusa-locale` header to the desired locale code in BCP 47 format. If you
+    don't pass a locale, and your store has a default locale, the default locale
+    will be used.
 
 
     With localization, the products' content like title and description will be
@@ -30,7 +30,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false
@@ -493,6 +493,7 @@ get:
             type: boolean
             title: $exists
             description: Filter by whether a value for this parameter exists (not `null`).
+        title: created_at
     - name: updated_at
       in: query
       description: Filter by the product's update date.
@@ -762,6 +763,7 @@ get:
             type: boolean
             title: $exists
             description: Filter by whether a value for this parameter exists (not `null`).
+        title: updated_at
     - name: region_id
       in: query
       description: >-

www/apps/api-reference/specs/store/paths/store_products_{id}.yaml

@@ -8,9 +8,9 @@ get:
 
     You can retrieve the content of the product translated to a specific locale
     either by passing the `locale` query parameter or by setting the
-    `Content-Language` header to the desired locale code in BCP 47 format. If
-    you don't pass a locale, and your store has a default locale, the default
-    locale will be used.
+    `x-medusa-locale` header to the desired locale code in BCP 47 format. If you
+    don't pass a locale, and your store has a default locale, the default locale
+    will be used.
 
 
     With localization, the product's content like title and description will be
@@ -36,7 +36,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

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

@@ -17,7 +17,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml

@@ -20,7 +20,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_return-reasons.yaml

@@ -14,7 +14,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml

@@ -20,7 +20,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

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

@@ -14,7 +14,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_shipping-options.yaml

@@ -21,7 +21,7 @@ get:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false

www/apps/api-reference/specs/store/paths/store_shipping-options_{id}_calculate.yaml

@@ -18,7 +18,7 @@ post:
         type: string
         externalDocs:
           url: https://docs.medusajs.com/api/store#publishable-api-key
-    - name: Content-Language
+    - name: x-medusa-locale
       in: header
       description: The locale in BCP 47 format to retrieve localized content.
       required: false