chore(docs): Updated API Reference (#6220)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-01-25 17:58:17 +00:00
parent 21c1c5ce6c
commit bbf79169a9
496 changed files with 3417 additions and 8305 deletions
--- a/www/apps/api-reference/specs/store/paths/store_carts.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts.yaml
@@ -27,7 +27,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_carts/postundefined
+        $ref: ../code_samples/tsx/store_carts/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml
@@ -19,7 +19,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_carts_{id}/getundefined
+        $ref: ../code_samples/tsx/store_carts_{id}/get.tsx
    - lang: Shell
      label: cURL
      source:
@@ -72,7 +72,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_carts_{id}/postundefined
+        $ref: ../code_samples/tsx/store_carts_{id}/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml
@@ -37,7 +37,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_carts_{id}_complete/postundefined
+        $ref: ../code_samples/tsx/store_carts_{id}_complete/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml
@@ -24,7 +24,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_carts_{id}_line-items/postundefined
+        $ref: ../code_samples/tsx/store_carts_{id}_line-items/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml
@@ -31,8 +31,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: >-
-          ../code_samples/tsx/store_carts_{id}_line-items_{line_id}/postundefined
+        $ref: ../code_samples/tsx/store_carts_{id}_line-items_{line_id}/post.tsx
    - lang: Shell
      label: cURL
      source:
@@ -86,8 +85,7 @@ delete:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: >-
-          ../code_samples/tsx/store_carts_{id}_line-items_{line_id}/deleteundefined
+        $ref: ../code_samples/tsx/store_carts_{id}_line-items_{line_id}/delete.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-session.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-session.yaml
@@ -27,7 +27,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_carts_{id}_payment-session/postundefined
+        $ref: ../code_samples/tsx/store_carts_{id}_payment-session/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions.yaml
@@ -23,7 +23,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_carts_{id}_payment-sessions/postundefined
+        $ref: ../code_samples/tsx/store_carts_{id}_payment-sessions/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}.yaml
@@ -35,7 +35,7 @@ post:
      label: Medusa React
      source:
        $ref: >-
-          ../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/postundefined
+          ../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/post.tsx
    - lang: Shell
      label: cURL
      source:
@@ -93,7 +93,7 @@ delete:
      label: Medusa React
      source:
        $ref: >-
-          ../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/deleteundefined
+          ../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/delete.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}_refresh.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}_refresh.yaml
@@ -31,7 +31,7 @@ post:
      label: Medusa React
      source:
        $ref: >-
-          ../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}_refresh/postundefined
+          ../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}_refresh/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml
@@ -26,7 +26,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_carts_{id}_shipping-methods/postundefined
+        $ref: ../code_samples/tsx/store_carts_{id}_shipping-methods/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_collections.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_collections.yaml
@@ -84,7 +84,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_collections/getundefined
+        $ref: ../code_samples/tsx/store_collections/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml
@@ -19,7 +19,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_collections_{id}/getundefined
+        $ref: ../code_samples/tsx/store_collections_{id}/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_customers.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_customers.yaml
@@ -22,7 +22,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_customers/postundefined
+        $ref: ../code_samples/tsx/store_customers/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_customers_me.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_customers_me.yaml
@@ -13,7 +13,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_customers_me/getundefined
+        $ref: ../code_samples/tsx/store_customers_me/get.tsx
    - lang: Shell
      label: cURL
      source:
@@ -62,7 +62,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_customers_me/postundefined
+        $ref: ../code_samples/tsx/store_customers_me/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_customers_me_orders.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_customers_me_orders.yaml
@@ -207,7 +207,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_customers_me_orders/getundefined
+        $ref: ../code_samples/tsx/store_customers_me_orders/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_gift-cards_{code}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_gift-cards_{code}.yaml
@@ -19,7 +19,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_gift-cards_{code}/getundefined
+        $ref: ../code_samples/tsx/store_gift-cards_{code}/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_order-edits_{id}.yaml
@@ -19,7 +19,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_order-edits_{id}/getundefined
+        $ref: ../code_samples/tsx/store_order-edits_{id}/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_complete.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_complete.yaml
@@ -25,7 +25,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_order-edits_{id}_complete/postundefined
+        $ref: ../code_samples/tsx/store_order-edits_{id}_complete/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_decline.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_decline.yaml
@@ -24,7 +24,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_order-edits_{id}_decline/postundefined
+        $ref: ../code_samples/tsx/store_order-edits_{id}_decline/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_orders.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_orders.yaml
@@ -52,7 +52,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_orders/getundefined
+        $ref: ../code_samples/tsx/store_orders/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_orders_batch_customer_token.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_orders_batch_customer_token.yaml
@@ -28,7 +28,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_orders_batch_customer_token/postundefined
+        $ref: ../code_samples/tsx/store_orders_batch_customer_token/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_orders_cart_{cart_id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_orders_cart_{cart_id}.yaml
@@ -21,7 +21,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_orders_cart_{cart_id}/getundefined
+        $ref: ../code_samples/tsx/store_orders_cart_{cart_id}/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_orders_customer_confirm.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_orders_customer_confirm.yaml
@@ -22,7 +22,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_orders_customer_confirm/postundefined
+        $ref: ../code_samples/tsx/store_orders_customer_confirm/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml
@@ -29,7 +29,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_orders_{id}/getundefined
+        $ref: ../code_samples/tsx/store_orders_{id}/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}.yaml
@@ -35,7 +35,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_payment-collections_{id}/getundefined
+        $ref: ../code_samples/tsx/store_payment-collections_{id}/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions.yaml
@@ -26,8 +26,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: >-
-          ../code_samples/tsx/store_payment-collections_{id}_sessions/postundefined
+        $ref: ../code_samples/tsx/store_payment-collections_{id}_sessions/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch.yaml
@@ -31,7 +31,7 @@ post:
      label: Medusa React
      source:
        $ref: >-
-          ../code_samples/tsx/store_payment-collections_{id}_sessions_batch/postundefined
+          ../code_samples/tsx/store_payment-collections_{id}_sessions_batch/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch_authorize.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch_authorize.yaml
@@ -28,7 +28,7 @@ post:
      label: Medusa React
      source:
        $ref: >-
-          ../code_samples/tsx/store_payment-collections_{id}_sessions_batch_authorize/postundefined
+          ../code_samples/tsx/store_payment-collections_{id}_sessions_batch_authorize/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}.yaml
@@ -30,7 +30,7 @@ post:
      label: Medusa React
      source:
        $ref: >-
-          ../code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}/postundefined
+          ../code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml
@@ -28,7 +28,7 @@ post:
      label: Medusa React
      source:
        $ref: >-
-          ../code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}_authorize/postundefined
+          ../code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}_authorize/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml
@@ -73,7 +73,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_product-categories/getundefined
+        $ref: ../code_samples/tsx/store_product-categories/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml
@@ -35,7 +35,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_product-categories_{id}/getundefined
+        $ref: ../code_samples/tsx/store_product-categories_{id}/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_product-tags.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_product-tags.yaml
@@ -108,7 +108,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_product-tags/getundefined
+        $ref: ../code_samples/tsx/store_product-tags/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_product-types.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_product-types.yaml
@@ -109,7 +109,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_product-types/getundefined
+        $ref: ../code_samples/tsx/store_product-types/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_products.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_products.yaml
@@ -240,7 +240,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_products/getundefined
+        $ref: ../code_samples/tsx/store_products/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml
@@ -79,7 +79,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_products_{id}/getundefined
+        $ref: ../code_samples/tsx/store_products_{id}/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_regions.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_regions.yaml
@@ -77,7 +77,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_regions/getundefined
+        $ref: ../code_samples/tsx/store_regions/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml
@@ -19,7 +19,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_regions_{id}/getundefined
+        $ref: ../code_samples/tsx/store_regions_{id}/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml
@@ -14,7 +14,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_return-reasons/getundefined
+        $ref: ../code_samples/tsx/store_return-reasons/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml
@@ -19,7 +19,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_return-reasons_{id}/getundefined
+        $ref: ../code_samples/tsx/store_return-reasons_{id}/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_returns.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_returns.yaml
@@ -22,7 +22,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_returns/postundefined
+        $ref: ../code_samples/tsx/store_returns/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml
@@ -36,7 +36,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_shipping-options/getundefined
+        $ref: ../code_samples/tsx/store_shipping-options/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_shipping-options_{cart_id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_shipping-options_{cart_id}.yaml
@@ -23,7 +23,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_shipping-options_{cart_id}/getundefined
+        $ref: ../code_samples/tsx/store_shipping-options_{cart_id}/get.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_swaps.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_swaps.yaml
@@ -36,7 +36,7 @@ post:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_swaps/postundefined
+        $ref: ../code_samples/tsx/store_swaps/post.tsx
    - lang: Shell
      label: cURL
      source:
--- a/www/apps/api-reference/specs/store/paths/store_swaps_{cart_id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_swaps_{cart_id}.yaml
@@ -19,7 +19,7 @@ get:
    - lang: tsx
      label: Medusa React
      source:
-        $ref: ../code_samples/tsx/store_swaps_{cart_id}/getundefined
+        $ref: ../code_samples/tsx/store_swaps_{cart_id}/get.tsx
    - lang: Shell
      label: cURL
      source: