docs: added a service factory reference (#8292)

Added a service factory reference of the generated methods and how to use them.

Since the types in the codebase are a bit complex, a generated reference won't provide a valuable result.

Instead, this reference is created manually and aims to cover common use cases, providing examples for them.

Closes DOCS-844
This commit is contained in:
Shahed Nasser
2024-07-26 17:40:56 +03:00
committed by GitHub
parent 71411463b1
commit a4eab3f37a
14 changed files with 1131 additions and 2 deletions
@@ -743,6 +743,46 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/recipes/subscriptions/page.mdx",
"pathname": "/recipes/subscriptions"
},
{
"filePath": "/www/apps/resources/app/service-factory-reference/methods/create/page.mdx",
"pathname": "/service-factory-reference/methods/create"
},
{
"filePath": "/www/apps/resources/app/service-factory-reference/methods/delete/page.mdx",
"pathname": "/service-factory-reference/methods/delete"
},
{
"filePath": "/www/apps/resources/app/service-factory-reference/methods/list/page.mdx",
"pathname": "/service-factory-reference/methods/list"
},
{
"filePath": "/www/apps/resources/app/service-factory-reference/methods/listAndCount/page.mdx",
"pathname": "/service-factory-reference/methods/listAndCount"
},
{
"filePath": "/www/apps/resources/app/service-factory-reference/methods/restore/page.mdx",
"pathname": "/service-factory-reference/methods/restore"
},
{
"filePath": "/www/apps/resources/app/service-factory-reference/methods/retrieve/page.mdx",
"pathname": "/service-factory-reference/methods/retrieve"
},
{
"filePath": "/www/apps/resources/app/service-factory-reference/methods/soft-delete/page.mdx",
"pathname": "/service-factory-reference/methods/soft-delete"
},
{
"filePath": "/www/apps/resources/app/service-factory-reference/methods/update/page.mdx",
"pathname": "/service-factory-reference/methods/update"
},
{
"filePath": "/www/apps/resources/app/service-factory-reference/page.mdx",
"pathname": "/service-factory-reference"
},
{
"filePath": "/www/apps/resources/app/service-factory-reference/tips/filtering/page.mdx",
"pathname": "/service-factory-reference/tips/filtering"
},
{
"filePath": "/www/apps/resources/app/storefront-development/cart/context/page.mdx",
"pathname": "/storefront-development/cart/context"
+91 -1
View File
@@ -7152,7 +7152,7 @@ export const generatedSidebar = [
{
"loaded": true,
"isPathHref": true,
"title": "API References",
"title": "References",
"hasTitleStyling": true,
"children": [
{
@@ -7398,6 +7398,96 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/service-factory-reference",
"title": "Service Factory Reference",
"isChildSidebar": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/service-factory-reference/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/service-factory-reference/methods/create",
"title": "create",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/service-factory-reference/methods/delete",
"title": "delete",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/service-factory-reference/methods/list",
"title": "list",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/service-factory-reference/methods/listAndCount",
"title": "listAndCount",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/service-factory-reference/methods/restore",
"title": "restore",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/service-factory-reference/methods/retrieve",
"title": "retrieve",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/service-factory-reference/methods/soft-delete",
"title": "softDelete",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/service-factory-reference/methods/update",
"title": "update",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Tips",
"hasTitleStyling": true,
"autogenerate_path": "/service-factory-reference/tips",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/service-factory-reference/tips/filtering",
"title": "Filtering",
"children": []
}
]
}
]
}
]
},