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/docs/content/references/medusa/classes/medusa.AdminPostInvitesReq.mdx
+1 -48
View File
@@ -8,51 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Properties
<ParameterTypes parameters={[
{
"name": "role",
"type": "[UserRoles](../../entities/enums/entities.UserRoles.mdx)",
"description": "The role of the user to be created. This does not actually change the privileges of the user that is eventually created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "ADMIN",
"type": "`\"admin\"`",
"description": "The user is an admin.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "DEVELOPER",
"type": "`\"developer\"`",
"description": "The user is a developer.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "MEMBER",
"type": "`\"member\"`",
"description": "The user is a team member.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "user",
"type": "`string`",
"description": "The email associated with the invite. Once the invite is accepted, the email will be associated with the created user.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
<ParameterTypes parameters={[{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The role of the user to be created. This does not actually change the privileges of the user that is eventually created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"user","type":"`string`","description":"The email associated with the invite. Once the invite is accepted, the email will be associated with the created user.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>