From e5ec907aad58d12788265e9850bbf6db0bd8f22f Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 10 Jun 2025 18:33:53 +0300 Subject: [PATCH] docs: fixes to references for draft orders and files (#12693) --- .../page.mdx | 6 +++--- .../file.AbstractFileProviderService/page.mdx | 13 +++++++++---- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.deleteDraftOrdersWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.deleteDraftOrdersWorkflow/page.mdx index 36825c7b91..846ac26414 100644 --- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.deleteDraftOrdersWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.deleteDraftOrdersWorkflow/page.mdx @@ -15,11 +15,11 @@ import { TypeList, WorkflowDiagram } from "docs-ui" This documentation provides a reference to the `deleteDraftOrdersWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. -This workflow deletes draft orders. +This workflow deletes draft orders. It's used by the [Delete Draft Order API route](https://docs.medusajs.com/api/admin#draft-orders\_deletedraftordersid). -You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around canceling an order. +You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around deleting a draft order. - + ## Examples diff --git a/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx b/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx index e17bfe0c6b..239fec18d6 100644 --- a/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx +++ b/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx @@ -123,23 +123,28 @@ deletes a product image, or other custom file deletions. ```ts class MyFileProviderService extends AbstractFileProviderService { // ... - async delete(file: ProviderDeleteFileDTO): Promise { + async delete( + files: FileTypes.ProviderDeleteFileDTO | FileTypes.ProviderDeleteFileDTO[] + ): Promise { // TODO logic to remove the file from storage // Use the `file.fileKey` to delete the file, which is the identifier of the file // in the provider's storage. // for example: - this.client.delete(file.fileKey) + const fileArray = Array.isArray(files) ? files : [files] + for (const file of fileArray) { + this.client.delete(file.fileKey) + } } } ``` #### Parameters - + #### Returns - + ### getAsBuffer