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
@@ -26,7 +26,7 @@ In this document, youll find common examples of how you can use the Inventory
request.scope.resolve(ModuleRegistrationName.INVENTORY)
const inventoryItem =
await inventoryModuleService.create({
await inventoryModuleService.createInventoryItems({
sku: request.body.sku,
title: request.body.title,
requires_shipping: request.body.requires_shipping,
@@ -52,7 +52,7 @@ In this document, youll find common examples of how you can use the Inventory
const body = await request.json()
const inventoryItem =
await inventoryModuleService.create({
await inventoryModuleService.createInventoryItems({
sku: body.sku,
title: body.title,
requires_shipping: body.requires_shipping,
@@ -85,7 +85,7 @@ In this document, youll find common examples of how you can use the Inventory
request.scope.resolve(ModuleRegistrationName.INVENTORY)
const inventoryItems =
await inventoryModuleService.list({})
await inventoryModuleService.listInventoryItems({})
res.json({ inventory_items: inventoryItems })
}
@@ -106,7 +106,7 @@ In this document, youll find common examples of how you can use the Inventory
await initializeInventoryModule({})
const inventoryItems =
await inventoryModuleService.list({})
await inventoryModuleService.listInventoryItems({})
return NextResponse.json({ inventory_items: inventoryItems })
}
@@ -135,7 +135,7 @@ In this document, youll find common examples of how you can use the Inventory
request.scope.resolve(ModuleRegistrationName.INVENTORY)
const inventoryItem =
await inventoryModuleService.retrieve(
await inventoryModuleService.retrieveInventoryItem(
request.params.id
)
@@ -167,7 +167,7 @@ In this document, youll find common examples of how you can use the Inventory
await initializeInventoryModule({})
const inventoryItem =
await inventoryModuleService.retrieve(
await inventoryModuleService.retrieveInventoryItem(
params.id
)