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
@@ -10,78 +10,4 @@ Details of the discount condition to create.
## Properties
<ParameterTypes parameters={[
{
"name": "customer_groups",
"type": "`string`[]",
"description": "The customer groups associated with the discount condition, if the discount condition's type is `customer_groups`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "operator",
"type": "[DiscountConditionOperator](../../entities/enums/entities.DiscountConditionOperator.mdx)",
"description": "The operator of the discount condition.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "IN",
"type": "`\"in\"`",
"description": "The discountable resources are within the specified resources.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "NOT_IN",
"type": "`\"not_in\"`",
"description": "The discountable resources are everything but the specified resources.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "product_collections",
"type": "`string`[]",
"description": "The product collections associated with the discount condition, if the discount condition's type is `product_collections`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "product_tags",
"type": "`string`[]",
"description": "The product tags associated with the discount condition, if the discount condition's type is `product_tags`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "product_types",
"type": "`string`[]",
"description": "The product types associated with the discount condition, if the discount condition's type is `product_types`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "products",
"type": "`string`[]",
"description": "The products associated with the discount condition, if the discount condition's type is `products`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
<ParameterTypes parameters={[{"name":"operator","type":"[DiscountConditionOperator](../../entities/enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the discount condition.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"IN","type":"`\"in\"`","description":"The discountable resources are within the specified resources.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_IN","type":"`\"not_in\"`","description":"The discountable resources are everything but the specified resources.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer_groups","type":"`string`[]","description":"The customer groups associated with the discount condition, if the discount condition's type is `customer_groups`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collections","type":"`string`[]","description":"The product collections associated with the discount condition, if the discount condition's type is `product_collections`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_tags","type":"`string`[]","description":"The product tags associated with the discount condition, if the discount condition's type is `product_tags`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_types","type":"`string`[]","description":"The product types associated with the discount condition, if the discount condition's type is `product_types`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`string`[]","description":"The products associated with the discount condition, if the discount condition's type is `products`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>