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,14 @@ In this guide, youll find common examples of how you can use the Store Module
const storeModuleService: IStoreModuleService =
request.scope.resolve(ModuleRegistrationName.STORE)
const store = await storeModuleService.create({
const store = await storeModuleService.createStores({
name: "My Store",
supported_currency_codes: ["usd"],
supported_currencies: [
{
currency_code: "usd",
is_default: true,
},
],
})
res.json({
@@ -49,9 +54,14 @@ In this guide, youll find common examples of how you can use the Store Module
export async function POST(request: Request) {
const storeModuleService = await initializeStoreModule()
const store = await storeModuleService.create({
const store = await storeModuleService.createStores({
name: "My Store",
supported_currency_codes: ["usd"],
supported_currencies: [
{
currency_code: "usd",
is_default: true,
},
],
})
res.json({
@@ -83,7 +93,7 @@ In this guide, youll find common examples of how you can use the Store Module
request.scope.resolve(ModuleRegistrationName.STORE)
res.json({
stores: await storeModuleService.list(),
stores: await storeModuleService.listStores(),
})
}
```
@@ -101,7 +111,7 @@ In this guide, youll find common examples of how you can use the Store Module
export async function GET(request: Request) {
const storeModuleService = await initializeStoreModule()
const salesChannels = await storeModuleService.list()
const salesChannels = await storeModuleService.listStores()
return NextResponse.json({
stores: await storeModuleService.list(),
@@ -131,7 +141,7 @@ In this guide, youll find common examples of how you can use the Store Module
const storeModuleService: IStoreModuleService =
request.scope.resolve(ModuleRegistrationName.STORE)
const store = await storeModuleService.retrieve(
const store = await storeModuleService.retrieveStore(
"store_123"
)
@@ -157,7 +167,7 @@ In this guide, youll find common examples of how you can use the Store Module
) {
const storeModuleService = await initializeStoreModule()
const store = await storeModuleService.retrieve(
const store = await storeModuleService.retrieveStore(
"store_123"
)
@@ -187,9 +197,10 @@ In this guide, youll find common examples of how you can use the Store Module
const storeModuleService: IStoreModuleService =
request.scope.resolve(ModuleRegistrationName.STORE)
const store = await storeModuleService.update("store_123", {
name: "Change Store",
})
const store = await storeModuleService
.updateStores("store_123", {
name: "Change Store",
})
res.json({
store,
@@ -213,9 +224,10 @@ In this guide, youll find common examples of how you can use the Store Module
) {
const storeModuleService = await initializeStoreModule()
const store = await storeModuleService.update("store_123", {
name: "Change Store",
})
const store = await storeModuleService
.updateStores("store_123", {
name: "Change Store",
})
return NextResponse.json({ store })
}
@@ -243,7 +255,7 @@ In this guide, youll find common examples of how you can use the Store Module
const storeModuleService: IStoreModuleService =
request.scope.resolve(ModuleRegistrationName.STORE)
await storeModuleService.delete("store_123")
await storeModuleService.deleteStores("store_123")
res.status(200)
}
@@ -265,7 +277,7 @@ In this guide, youll find common examples of how you can use the Store Module
) {
const storeModuleService = await initializeStoreModule()
await storeModuleService.delete("store_123")
await storeModuleService.deleteStores("store_123")
}
```