docs: updates to use DML and other changes (#7834)

- Change existing data model guides and add new ones for DML
- Change module's docs around service factory + remove guides that are now necessary
- Hide/remove all mentions of module relationships, or label them as coming soon.
- Change all data model creation snippets to use DML
- use `property` instead of `field` when referring to a data model's properties.
- Fix all snippets in commerce module guides to use new method suffix (no more main model methods)
- Rework recipes, removing/hiding a lot of sections as a lot of recipes are incomplete with the current state of DML.


### Other changes

- Highlight fixes in some guides
- Remove feature flags guide
- Fix code block styles when there are no line numbers.

### Upcoming changes in other PRs

- Re-generate commerce module references (for the updates in the method names)
- Ensure that the data model references are generated correctly for models using DML.
- (probably at a very later point) revisit recipes
This commit is contained in:
Shahed Nasser
2024-06-26 07:55:59 +00:00
committed by GitHub
parent 62dacdda75
commit 0462cc5acf
126 changed files with 1808 additions and 14242 deletions
@@ -12,7 +12,7 @@ There are two types of API keys:
- `publishable`: A public key used in client applications, such as a storefront.
- `secret`: A secret key used for authentication and verification purposes, such as an admin users authentication token or a password reset token.
The API keys type is stored in the `type` field of the [ApiKey data model](/references/api-key/models/ApiKey).
The API keys type is stored in the `type` property of the [ApiKey data model](/references/api-key/models/ApiKey).
---
@@ -25,7 +25,7 @@ In this guide, youll find common examples of how you can use the API Key Modu
const apiKeyModuleService: IApiKeyModuleService =
request.scope.resolve(ModuleRegistrationName.API_KEY)
const apiKey = await apiKeyModuleService.create({
const apiKey = await apiKeyModuleService.createApiKeys({
title: "Publishable API key",
type: "publishable",
created_by: "user_123",
@@ -50,7 +50,7 @@ In this guide, youll find common examples of how you can use the API Key Modu
export async function POST(request: Request) {
const apiKeyModuleService = await initializeApiKeyModule()
const apiKey = await apiKeyModuleService.create({
const apiKey = await apiKeyModuleService.createApiKeys({
title: "Publishable API key",
type: "publishable",
created_by: "user_123",
@@ -85,7 +85,7 @@ In this guide, youll find common examples of how you can use the API Key Modu
request.scope.resolve(ModuleRegistrationName.API_KEY)
res.json({
api_keys: await apiKeyModuleService.list(),
api_keys: await apiKeyModuleService.listApiKeys(),
})
}
```
@@ -104,7 +104,7 @@ In this guide, youll find common examples of how you can use the API Key Modu
const apiKeyModuleService = await initializeApiKeyModule()
return NextResponse.json({
api_keys: await apiKeyModuleService.list(),
api_keys: await apiKeyModuleService.listApiKeys(),
})
}
```
@@ -279,7 +279,7 @@ In this guide, youll find common examples of how you can use the API Key Modu
}
)
const newKey = await apiKeyModuleService.create({
const newKey = await apiKeyModuleService.createApiKeys({
title: revokedKey.title,
type: revokedKey.type,
created_by: revokedKey.created_by,
@@ -318,7 +318,7 @@ In this guide, youll find common examples of how you can use the API Key Modu
revoked_by: params.user_id,
})
const newKey = await apiKeyModuleService.create({
const newKey = await apiKeyModuleService.createApiKeys({
title: revokedKey.title,
type: revokedKey.type,
created_by: revokedKey.created_by,
@@ -19,13 +19,13 @@ Store and manage API keys in your store. You can create both publishable and sec
- Password reset tokens when a user or customer requests to reset their password.
```ts
const pubApiKey = await apiKeyModuleService.create({
const pubApiKey = await apiKeyModuleService.createApiKeys({
title: "Publishable API key",
type: "publishable",
created_by: "user_123",
})
const secretApiKey = await apiKeyModuleService.create({
const secretApiKey = await apiKeyModuleService.createApiKeys({
title: "Authentication Key",
type: "secret",
created_by: "user_123",
@@ -66,7 +66,7 @@ const revokedKey = await apiKeyModuleService.revoke("apk_1", {
revoked_by: "user_123",
})
const newKey = await apiKeyModuleService.create({
const newKey = await apiKeyModuleService.createApiKeys({
title: revokedKey.title,
type: revokedKey.type,
created_by: revokedKey.created_by,
@@ -97,7 +97,7 @@ For example:
request.scope.resolve(ModuleRegistrationName.API_KEY)
res.json({
api_keys: await apiKeyModuleService.list(),
api_keys: await apiKeyModuleService.listApiKeys(),
})
}
```
@@ -116,7 +116,7 @@ For example:
const apiKeyModuleService: IApiKeyModuleService =
container.resolve(ModuleRegistrationName.API_KEY)
const apiKeys = await apiKeyModuleService.list()
const apiKeys = await apiKeyModuleService.listApiKeys()
}
```
@@ -136,7 +136,7 @@ For example:
ModuleRegistrationName.API_KEY
)
const apiKeys = await apiKeyModuleService.list()
const apiKeys = await apiKeyModuleService.listApiKeys()
})
```