docs: generate medusa-react reference (#6004)

* 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
@@ -1,4 +1,5 @@
type: object
description: The details of the payment session to manage.
required:
- provider_id
properties:
@@ -1,4 +1,5 @@
type: object
description: The details of the payment session.
required:
- payment_session
properties:
@@ -1,4 +1,5 @@
type: object
description: The details to update of the line item.
required:
- quantity
properties:
@@ -1,4 +1,5 @@
type: object
description: The details of the line item to create.
required:
- variant_id
- quantity
@@ -1,4 +1,5 @@
type: object
description: The details of the payment session to set.
required:
- provider_id
properties:
@@ -1,4 +1,5 @@
type: object
description: The details to update of the cart.
properties:
region_id:
type: string
@@ -1,4 +1,5 @@
type: object
description: The details of the shipping method to add to the cart.
required:
- option_id
properties:
@@ -1,4 +1,5 @@
type: object
description: The details necessary to grant order access.
required:
- token
properties:
@@ -1,4 +1,5 @@
type: object
description: The details of the orders to claim.
required:
- order_ids
properties:
@@ -1,4 +1,5 @@
type: object
description: The details to update of the customer.
properties:
first_name:
description: The customer's first name.
@@ -1,4 +1,5 @@
type: object
description: The details of the customer to create.
required:
- first_name
- last_name
@@ -1,4 +1,5 @@
type: object
description: The details of the order edit's decline.
properties:
declined_reason:
type: string
@@ -1,4 +1,5 @@
type: object
description: The details of the payment sessions to authorize.
required:
- session_ids
properties:
@@ -1,4 +1,5 @@
type: object
description: The details of the payment sessions to manage.
required:
- sessions
properties:
@@ -1,4 +1,5 @@
type: object
description: The details of the return to create.
required:
- order_id
- items
@@ -1,4 +1,5 @@
type: object
description: The details of the swap to create.
required:
- order_id
- return_items