asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: generate medusa-react reference (#6004)

Browse Source 
* add new plugin for better organization

* added handling in theme for mutations and query types

* added tsdoc to hooks

* added tsdocs to utility functions

* added tsdoc to providers

* generated reference

* general fixes for generated reference

* generated api reference specs + general fixes

* add missing import react

* split utilities into different directories

* added overview page

* added link to customer authentication section

* fix lint errors

* added changeset

* fix readme

* fixed build error

* added expand fields + other sections to overview

* updated what's new section

* general refactoring

* remove unnecessary query field

* fix links

* added ignoreApi option
This commit is contained in:
Shahed Nasser
2024-01-05 17:03:38 +02:00
committed by GitHub
parent 6fc6a9de6a
commit 7d650771d1
2811 changed files with 231856 additions and 455063 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/store/paths/store_carts.yaml
+4
View File
@@ -24,6 +24,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_carts/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_carts/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml
+8
View File
@@ -16,6 +16,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_carts_{id}/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_carts_{id}/getundefined
- lang: Shell
label: cURL
source:
@@ -65,6 +69,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_carts_{id}/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_carts_{id}/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml
+4
View File
@@ -34,6 +34,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_carts_{id}_complete/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_carts_{id}_complete/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml
+4
View File
@@ -21,6 +21,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_carts_{id}_line-items/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_carts_{id}_line-items/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml
+10
View File
@@ -28,6 +28,11 @@ post:
source:
$ref: >-
../code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/post.js
- lang: tsx
label: Medusa React
source:
$ref: >-
../code_samples/tsx/store_carts_{id}_line-items_{line_id}/postundefined
- lang: Shell
label: cURL
source:
@@ -78,6 +83,11 @@ delete:
source:
$ref: >-
../code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/delete.js
- lang: tsx
label: Medusa React
source:
$ref: >-
../code_samples/tsx/store_carts_{id}_line-items_{line_id}/deleteundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-session.yaml
+4
View File
@@ -24,6 +24,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_carts_{id}_payment-session/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_carts_{id}_payment-session/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions.yaml
+4
View File
@@ -20,6 +20,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_carts_{id}_payment-sessions/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_carts_{id}_payment-sessions/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}.yaml
+10
View File
@@ -31,6 +31,11 @@ post:
source:
$ref: >-
../code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/post.js
- lang: tsx
label: Medusa React
source:
$ref: >-
../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/postundefined
- lang: Shell
label: cURL
source:
@@ -84,6 +89,11 @@ delete:
source:
$ref: >-
../code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/delete.js
- lang: tsx
label: Medusa React
source:
$ref: >-
../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/deleteundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}_refresh.yaml
+5
View File
@@ -27,6 +27,11 @@ post:
source:
$ref: >-
../code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}_refresh/post.js
- lang: tsx
label: Medusa React
source:
$ref: >-
../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}_refresh/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml
+4
View File
@@ -23,6 +23,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_carts_{id}_shipping-methods/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_carts_{id}_shipping-methods/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_collections.yaml
+4
View File
@@ -81,6 +81,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_collections/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_collections/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml
+4
View File
@@ -16,6 +16,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_collections_{id}/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_collections_{id}/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_customers.yaml
+4
View File
@@ -19,6 +19,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_customers/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_customers/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_customers_me.yaml
+8
View File
@@ -10,6 +10,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_customers_me/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_customers_me/getundefined
- lang: Shell
label: cURL
source:
@@ -55,6 +59,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_customers_me/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_customers_me/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_customers_me_orders.yaml
+4
View File
@@ -204,6 +204,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_customers_me_orders/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_customers_me_orders/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_gift-cards_{code}.yaml
+4
View File
@@ -16,6 +16,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_gift-cards_{code}/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_gift-cards_{code}/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_order-edits_{id}.yaml
+4
View File
@@ -16,6 +16,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_order-edits_{id}/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_order-edits_{id}/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_order-edits_{id}_complete.yaml
+4
View File
@@ -22,6 +22,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_order-edits_{id}_complete/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_order-edits_{id}_complete/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_order-edits_{id}_decline.yaml
+4
View File
@@ -21,6 +21,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_order-edits_{id}_decline/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_order-edits_{id}_decline/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_orders.yaml
+4
View File
@@ -49,6 +49,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_orders/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_orders/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_orders_batch_customer_token.yaml
+4
View File
@@ -25,6 +25,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_orders_batch_customer_token/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_orders_batch_customer_token/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_orders_cart_{cart_id}.yaml
+4
View File
@@ -18,6 +18,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_orders_cart_{cart_id}/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_orders_cart_{cart_id}/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_orders_customer_confirm.yaml
+4
View File
@@ -19,6 +19,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_orders_customer_confirm/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_orders_customer_confirm/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml
+4
View File
@@ -26,6 +26,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_orders_{id}/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_orders_{id}/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_payment-collections_{id}.yaml
+4
View File
@@ -32,6 +32,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_payment-collections_{id}/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_payment-collections_{id}/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions.yaml
+5
View File
@@ -23,6 +23,11 @@ post:
source:
$ref: >-
../code_samples/JavaScript/store_payment-collections_{id}_sessions/post.js
- lang: tsx
label: Medusa React
source:
$ref: >-
../code_samples/tsx/store_payment-collections_{id}_sessions/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch.yaml
+5
View File
@@ -27,6 +27,11 @@ post:
source:
$ref: >-
../code_samples/JavaScript/store_payment-collections_{id}_sessions_batch/post.js
- lang: tsx
label: Medusa React
source:
$ref: >-
../code_samples/tsx/store_payment-collections_{id}_sessions_batch/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch_authorize.yaml
+5
View File
@@ -24,6 +24,11 @@ post:
source:
$ref: >-
../code_samples/JavaScript/store_payment-collections_{id}_sessions_batch_authorize/post.js
- lang: tsx
label: Medusa React
source:
$ref: >-
../code_samples/tsx/store_payment-collections_{id}_sessions_batch_authorize/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}.yaml
+5
View File
@@ -26,6 +26,11 @@ post:
source:
$ref: >-
../code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}/post.js
- lang: tsx
label: Medusa React
source:
$ref: >-
../code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml
+5
View File
@@ -24,6 +24,11 @@ post:
source:
$ref: >-
../code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}_authorize/post.js
- lang: tsx
label: Medusa React
source:
$ref: >-
../code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}_authorize/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_product-categories.yaml
+4
View File
@@ -70,6 +70,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_product-categories/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_product-categories/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml
+4
View File
@@ -32,6 +32,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_product-categories_{id}/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_product-categories_{id}/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_product-tags.yaml
+4
View File
@@ -105,6 +105,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_product-tags/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_product-tags/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_product-types.yaml
+4
View File
@@ -106,6 +106,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_product-types/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_product-types/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_products.yaml
+4
View File
@@ -237,6 +237,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_products/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_products/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_products_{id}.yaml
+4
View File
@@ -76,6 +76,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_products_{id}/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_products_{id}/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_regions.yaml
+4
View File
@@ -74,6 +74,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_regions/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_regions/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml
+4
View File
@@ -16,6 +16,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_regions_{id}/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_regions_{id}/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_return-reasons.yaml
+4
View File
@@ -11,6 +11,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_return-reasons/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_return-reasons/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml
+4
View File
@@ -16,6 +16,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_return-reasons_{id}/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_return-reasons_{id}/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_returns.yaml
+4
View File
@@ -19,6 +19,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_returns/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_returns/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_shipping-options.yaml
+4
View File
@@ -33,6 +33,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_shipping-options/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_shipping-options/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_shipping-options_{cart_id}.yaml
+4
View File
@@ -20,6 +20,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_shipping-options_{cart_id}/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_shipping-options_{cart_id}/getundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_swaps.yaml
+4
View File
@@ -33,6 +33,10 @@ post:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_swaps/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_swaps/postundefined
- lang: Shell
label: cURL
source:
www/apps/api-reference/specs/store/paths/store_swaps_{cart_id}.yaml
+4
View File
@@ -16,6 +16,10 @@ get:
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_swaps_{cart_id}/get.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/store_swaps_{cart_id}/getundefined
- lang: Shell
label: cURL
source: