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

docs: edits and fixes to commerce module docs (#7468)

Browse Source 
Apply edits and fixes to the commerce modules docs
This commit is contained in:
Shahed Nasser
2024-05-29 11:08:06 +00:00
committed by GitHub
parent 130de74d6d
commit 2c5ba408d4
160 changed files with 6400 additions and 3790 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/references/modules/auth/page.mdx
+4 -4
View File
@@ -4,10 +4,10 @@ import { TypeList } from "docs-ui"
## Interfaces
- [AuthUserDTO](../../auth/interfaces/auth.AuthUserDTO/page.mdx)
- [CreateAuthUserDTO](../../auth/interfaces/auth.CreateAuthUserDTO/page.mdx)
- [UpdateAuthUserDTO](../../auth/interfaces/auth.UpdateAuthUserDTO/page.mdx)
- [FilterableAuthUserProps](../../auth/interfaces/auth.FilterableAuthUserProps/page.mdx)
- [AuthIdentityDTO](../../auth/interfaces/auth.AuthIdentityDTO/page.mdx)
- [CreateAuthIdentityDTO](../../auth/interfaces/auth.CreateAuthIdentityDTO/page.mdx)
- [UpdateAuthIdentityDTO](../../auth/interfaces/auth.UpdateAuthIdentityDTO/page.mdx)
- [FilterableAuthIdentityProps](../../auth/interfaces/auth.FilterableAuthIdentityProps/page.mdx)
- [AuthenticationResponse](../../auth/interfaces/auth.AuthenticationResponse/page.mdx)
- [AuthenticationInput](../../auth/interfaces/auth.AuthenticationInput/page.mdx)
- [IAuthModuleService](../../auth/interfaces/auth.IAuthModuleService/page.mdx)
www/apps/resources/references/modules/auth_models/page.mdx
+1 -1
View File
@@ -11,4 +11,4 @@ This documentation provides a reference to the data models in the Auth Module
## Classes
- [AuthUser](../../auth_models/classes/auth_models.AuthUser/page.mdx)
- [AuthIdentity](../../auth_models/classes/auth_models.AuthIdentity/page.mdx)
www/apps/resources/references/modules/auth_provider/page.mdx
+7
View File
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# auth-provider
## Classes
- [AbstractAuthModuleProvider](../../auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx)
www/apps/resources/references/modules/fulfillment_provider/page.mdx
+7
View File
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# fulfillment-provider
## Classes
- [AbstractFulfillmentProviderService](../../fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx)
www/apps/resources/references/modules/medusa/page.mdx
+6 -2
View File
@@ -1105,10 +1105,12 @@ ___
<TypeList types={[{"name":"RequestHandler","type":"RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ParamsDictionary","type":"`ParamsDictionary`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"ParsedQs","type":"`ParsedQs`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Record","type":"`Record<string, any>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="wrapHandler"/>
#### Deprecated
:::note[Deprecated]
use `import { wrapHandler } from "@medusajs/utils"`
:::
### canAccessBatchJob
#### Parameters
@@ -1285,10 +1287,12 @@ Middleware that transform the query input for the store endpoints
<TypeList types={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
#### Deprecated
:::note[Deprecated]
use `transformQuery` instead
:::
### reserveQuantityForDraftOrder
#### Parameters
www/apps/resources/references/modules/medusa_config/page.mdx
+1
View File
@@ -4,6 +4,7 @@ import { TypeList } from "docs-ui"
## Interfaces
- [AdminOptions](../../medusa_config/interfaces/medusa_config.AdminOptions/page.mdx)
- [HttpCompressionOptions](../../medusa_config/interfaces/medusa_config.HttpCompressionOptions/page.mdx)
- [ProjectConfigOptions](../../medusa_config/interfaces/medusa_config.ProjectConfigOptions/page.mdx)
- [ConfigModule](../../medusa_config/interfaces/medusa_config.ConfigModule/page.mdx)