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
@@ -25,9 +25,10 @@ In this guide, youll find common examples of how you can use the Sales Channe
const salesChannelModuleService: ISalesChannelModuleService =
request.scope.resolve(ModuleRegistrationName.SALES_CHANNEL)
const salesChannel = await salesChannelModuleService.create({
name: "B2B",
})
const salesChannel = await salesChannelModuleService
.createSalesChannels({
name: "B2B",
})
res.json({
sales_channel: salesChannel,
@@ -49,9 +50,10 @@ In this guide, youll find common examples of how you can use the Sales Channe
const salesChannelModuleService =
await initializeSalesChannelModule()
const salesChannel = await salesChannelModuleService.create({
name: "B2B",
})
const salesChannel = await salesChannelModuleService
.createSalesChannels({
name: "B2B",
})
return NextResponse.json({ sales_channel: salesChannel })
}
@@ -80,7 +82,8 @@ In this guide, youll find common examples of how you can use the Sales Channe
request.scope.resolve(ModuleRegistrationName.SALES_CHANNEL)
res.json({
sales_channels: salesChannelModuleService.list(),
sales_channels: salesChannelModuleService
.listSalesChannels(),
})
}
```
@@ -99,7 +102,8 @@ In this guide, youll find common examples of how you can use the Sales Channe
const salesChannelModuleService =
await initializeSalesChannelModule()
const salesChannels = await salesChannelModuleService.list()
const salesChannels = await salesChannelModuleService
.listSalesChannels()
return NextResponse.json({ sales_channels: salesChannels })
}
@@ -127,9 +131,10 @@ In this guide, youll find common examples of how you can use the Sales Channe
const salesChannelModuleService: ISalesChannelModuleService =
request.scope.resolve(ModuleRegistrationName.SALES_CHANNEL)
const salesChannel = await salesChannelModuleService.retrieve(
"sc_123"
)
const salesChannel = await salesChannelModuleService
.retrieveSalesChannel(
"sc_123"
)
res.json({
sales_channel: salesChannel,
@@ -153,9 +158,10 @@ In this guide, youll find common examples of how you can use the Sales Channe
const salesChannelModuleService =
await initializeSalesChannelModule()
const salesChannel = await salesChannelModuleService.retrieve(
"sc_123"
)
const salesChannel = await salesChannelModuleService
.retrieveSalesChannel(
"sc_123"
)
return NextResponse.json({ sales_channel: salesChannel })
}
@@ -183,10 +189,11 @@ In this guide, youll find common examples of how you can use the Sales Channe
const salesChannelModuleService: ISalesChannelModuleService =
request.scope.resolve(ModuleRegistrationName.SALES_CHANNEL)
const salesChannel = await salesChannelModuleService.update({
id: "sc_123",
description: "Sales channel for B2B customers",
})
const salesChannel = await salesChannelModuleService
.updateSalesChannels({
id: "sc_123",
description: "Sales channel for B2B customers",
})
res.json({
sales_channel: salesChannel,
@@ -210,10 +217,11 @@ In this guide, youll find common examples of how you can use the Sales Channe
const salesChannelModuleService =
await initializeSalesChannelModule()
const salesChannel = await salesChannelModuleService.update({
id: "sc_123",
description: "Sales channel for B2B customers",
})
const salesChannel = await salesChannelModuleService
.updateSalesChannels({
id: "sc_123",
description: "Sales channel for B2B customers",
})
return NextResponse.json({ sales_channel: salesChannel })
}
@@ -241,7 +249,7 @@ In this guide, youll find common examples of how you can use the Sales Channe
const salesChannelModuleService: ISalesChannelModuleService =
request.scope.resolve(ModuleRegistrationName.SALES_CHANNEL)
await salesChannelModuleService.delete("sc_123")
await salesChannelModuleService.deleteSalesChannels("sc_123")
res.status(200)
}
@@ -263,7 +271,7 @@ In this guide, youll find common examples of how you can use the Sales Channe
const salesChannelModuleService =
await initializeSalesChannelModule()
await salesChannelModuleService.delete("sc_123")
await salesChannelModuleService.deleteSalesChannels("sc_123")
}
```