From 55c42e112e4c7babcc6d2a5f75ec423706b775ce Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 22 Oct 2025 18:43:35 +0300 Subject: [PATCH] docs: change binary encoding to base64 in file upload references (#13811) --- .../page.mdx | 4 ++-- .../page.mdx | 10 +++++----- .../types/core_flows.UploadFilesStepInput/page.mdx | 2 +- .../types/core_flows.UploadFilesWorkflowInput/page.mdx | 2 +- .../classes/file.AbstractFileProviderService/page.mdx | 2 +- .../file_service.IFileModuleService/page.mdx | 8 ++++---- .../interfaces/types.FileTypes.CreateFileDTO/page.mdx | 2 +- .../types.FileTypes.IFileModuleService/page.mdx | 8 ++++---- .../interfaces/types.FileTypes.IFileProvider/page.mdx | 2 +- .../types.FileTypes.ProviderUploadFileDTO/page.mdx | 2 +- 10 files changed, 21 insertions(+), 21 deletions(-) diff --git a/www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx b/www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx index 958d83e4ab..192cf4e968 100644 --- a/www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx +++ b/www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx @@ -23,7 +23,7 @@ const data = uploadFilesStep({ { filename: "test.jpg", mimeType: "img/jpg", - content: "binary-string", + content: "base64-string", access: "public" } ] @@ -32,7 +32,7 @@ const data = uploadFilesStep({ ## Input - + ## Output diff --git a/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx b/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx index 68236322e6..98db04dca5 100644 --- a/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx @@ -44,7 +44,7 @@ export async function POST( files: [{ filename: "test.jpg", mimeType: "img/jpg", - content: "binary-string", + content: "base64-string", access: "public" }] } @@ -74,7 +74,7 @@ export default async function handleOrderPlaced({ files: [{ filename: "test.jpg", mimeType: "img/jpg", - content: "binary-string", + content: "base64-string", access: "public" }] } @@ -104,7 +104,7 @@ export default async function myCustomJob( files: [{ filename: "test.jpg", mimeType: "img/jpg", - content: "binary-string", + content: "base64-string", access: "public" }] } @@ -135,7 +135,7 @@ const myWorkflow = createWorkflow( files: [{ filename: "test.jpg", mimeType: "img/jpg", - content: "binary-string", + content: "base64-string", access: "public" }] } @@ -153,7 +153,7 @@ const myWorkflow = createWorkflow( ## Input - + ## Output diff --git a/www/apps/resources/references/core_flows/types/core_flows.UploadFilesStepInput/page.mdx b/www/apps/resources/references/core_flows/types/core_flows.UploadFilesStepInput/page.mdx index 8f4cf930d4..a0f4fa0546 100644 --- a/www/apps/resources/references/core_flows/types/core_flows.UploadFilesStepInput/page.mdx +++ b/www/apps/resources/references/core_flows/types/core_flows.UploadFilesStepInput/page.mdx @@ -6,4 +6,4 @@ import { TypeList, WorkflowDiagram } from "docs-ui" The data to upload files. - + diff --git a/www/apps/resources/references/core_flows/types/core_flows.UploadFilesWorkflowInput/page.mdx b/www/apps/resources/references/core_flows/types/core_flows.UploadFilesWorkflowInput/page.mdx index 3851fec282..b6b02fd669 100644 --- a/www/apps/resources/references/core_flows/types/core_flows.UploadFilesWorkflowInput/page.mdx +++ b/www/apps/resources/references/core_flows/types/core_flows.UploadFilesWorkflowInput/page.mdx @@ -6,4 +6,4 @@ import { TypeList, WorkflowDiagram } from "docs-ui" The data to upload files. - + 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 4399e39202..6dda1f9dec 100644 --- a/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx +++ b/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx @@ -316,7 +316,7 @@ class MyFileProviderService extends AbstractFileProviderService { #### Parameters - + #### Returns diff --git a/www/apps/resources/references/file_service/interfaces/file_service.IFileModuleService/page.mdx b/www/apps/resources/references/file_service/interfaces/file_service.IFileModuleService/page.mdx index 25b9ef5fca..d96b661399 100644 --- a/www/apps/resources/references/file_service/interfaces/file_service.IFileModuleService/page.mdx +++ b/www/apps/resources/references/file_service/interfaces/file_service.IFileModuleService/page.mdx @@ -51,13 +51,13 @@ This method uploads files to the designated file storage system. const [file] = await fileModuleService.createFiles([{ filename: "product.png", mimeType: "image/png", - content: "somecontent" // binary string + content: "somecontent" // base64 string }]) ``` #### Parameters - + #### Returns @@ -73,13 +73,13 @@ This method uploads a file to the designated file storage system. const file = await fileModuleService.createFiles({ filename: "product.png", mimeType: "image/png", - content: "somecontent" // binary string + content: "somecontent" // base64 string }) ``` #### Parameters - + #### Returns diff --git a/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx b/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx index 9da2fd26dc..ea6353a9ef 100644 --- a/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx +++ b/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx @@ -6,4 +6,4 @@ The File to be created. ## Properties - + diff --git a/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.IFileModuleService/page.mdx b/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.IFileModuleService/page.mdx index 55c6d5fcda..d2c35b146a 100644 --- a/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.IFileModuleService/page.mdx +++ b/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.IFileModuleService/page.mdx @@ -32,13 +32,13 @@ This method uploads files to the designated file storage system. const [file] = await fileModuleService.createFiles([{ filename: "product.png", mimeType: "image/png", - content: "somecontent" // binary string + content: "somecontent" // base64 string }]) ``` #### Parameters - + #### Returns @@ -54,13 +54,13 @@ This method uploads a file to the designated file storage system. const file = await fileModuleService.createFiles({ filename: "product.png", mimeType: "image/png", - content: "somecontent" // binary string + content: "somecontent" // base64 string }) ``` #### Parameters - + #### Returns diff --git a/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.IFileProvider/page.mdx b/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.IFileProvider/page.mdx index d108ee8f2f..9fe41482bc 100644 --- a/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.IFileProvider/page.mdx +++ b/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.IFileProvider/page.mdx @@ -10,7 +10,7 @@ This method is used to upload a file #### Parameters - + #### Returns diff --git a/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx b/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx index e3532be665..b4a09d5cf2 100644 --- a/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx +++ b/www/apps/resources/references/types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx @@ -6,4 +6,4 @@ The details of the file to create. ## Properties - +