From 7e92aa3d495f61e6c063ab868f14aad0e717f3bb Mon Sep 17 00:00:00 2001 From: -LAN- Date: Wed, 27 May 2026 22:57:01 +0800 Subject: [PATCH] docs: require user for file upload API (#794) * docs(api-reference): require user for file upload Mark the user form field as required for the shared files/upload Service API endpoint in chat, chatflow, completion, and workflow specs. Update the field description to clarify that Service API conversations are separate from WebApp conversations. * docs(api-reference): clarify file upload user field and sync zh/ja --------- Co-authored-by: RiskeyL <7a8y@163.com> (cherry picked from commit 9b82c3e7f2902aa2d160c1483c08437b292713c1) --- en/api-reference/openapi_chat.json | 5 +++-- en/api-reference/openapi_chatflow.json | 5 +++-- en/api-reference/openapi_completion.json | 5 +++-- en/api-reference/openapi_workflow.json | 5 +++-- ja/api-reference/openapi_chat.json | 5 +++-- ja/api-reference/openapi_chatflow.json | 5 +++-- ja/api-reference/openapi_completion.json | 5 +++-- ja/api-reference/openapi_workflow.json | 5 +++-- zh/api-reference/openapi_chat.json | 5 +++-- zh/api-reference/openapi_chatflow.json | 5 +++-- zh/api-reference/openapi_completion.json | 5 +++-- zh/api-reference/openapi_workflow.json | 5 +++-- 12 files changed, 36 insertions(+), 24 deletions(-) diff --git a/en/api-reference/openapi_chat.json b/en/api-reference/openapi_chat.json index a418995ff..e70a76ae7 100644 --- a/en/api-reference/openapi_chat.json +++ b/en/api-reference/openapi_chat.json @@ -470,7 +470,8 @@ "schema": { "type": "object", "required": [ - "file" + "file", + "user" ], "properties": { "file": { @@ -480,7 +481,7 @@ }, "user": { "type": "string", - "description": "User identifier, defined by the developer's rules, must be unique within the application." + "description": "Identifier for the end user, defined by your application's rules and unique within the app. Service API and WebApp user IDs are separate, even when identical." } } } diff --git a/en/api-reference/openapi_chatflow.json b/en/api-reference/openapi_chatflow.json index 6c1e08125..d83471bab 100644 --- a/en/api-reference/openapi_chatflow.json +++ b/en/api-reference/openapi_chatflow.json @@ -498,7 +498,8 @@ "schema": { "type": "object", "required": [ - "file" + "file", + "user" ], "properties": { "file": { @@ -508,7 +509,7 @@ }, "user": { "type": "string", - "description": "User identifier, defined by the developer's rules, must be unique within the application." + "description": "Identifier for the end user, defined by your application's rules and unique within the app. Service API and WebApp user IDs are separate, even when identical." } } } diff --git a/en/api-reference/openapi_completion.json b/en/api-reference/openapi_completion.json index 625121374..fa2276c9d 100644 --- a/en/api-reference/openapi_completion.json +++ b/en/api-reference/openapi_completion.json @@ -443,7 +443,8 @@ "schema": { "type": "object", "required": [ - "file" + "file", + "user" ], "properties": { "file": { @@ -453,7 +454,7 @@ }, "user": { "type": "string", - "description": "User identifier, defined by the developer's rules, must be unique within the application." + "description": "Identifier for the end user, defined by your application's rules and unique within the app. Service API and WebApp user IDs are separate, even when identical." } } } diff --git a/en/api-reference/openapi_workflow.json b/en/api-reference/openapi_workflow.json index 1327c257c..7a114b4f1 100644 --- a/en/api-reference/openapi_workflow.json +++ b/en/api-reference/openapi_workflow.json @@ -773,7 +773,8 @@ "schema": { "type": "object", "required": [ - "file" + "file", + "user" ], "properties": { "file": { @@ -783,7 +784,7 @@ }, "user": { "type": "string", - "description": "User identifier, defined by the developer's rules, must be unique within the application." + "description": "Identifier for the end user, defined by your application's rules and unique within the app. Service API and WebApp user IDs are separate, even when identical." } } } diff --git a/ja/api-reference/openapi_chat.json b/ja/api-reference/openapi_chat.json index 98513f516..9fea37a16 100644 --- a/ja/api-reference/openapi_chat.json +++ b/ja/api-reference/openapi_chat.json @@ -470,7 +470,8 @@ "schema": { "type": "object", "required": [ - "file" + "file", + "user" ], "properties": { "file": { @@ -480,7 +481,7 @@ }, "user": { "type": "string", - "description": "ユーザー識別子。開発者のルールで定義され、アプリケーション内で一意である必要があります。" + "description": "ユーザー識別子。開発者のルールで定義され、アプリケーション内で一意である必要があります。Service API と WebApp のユーザー ID は独立しており、値が同じでも同じユーザーを指しません。" } } } diff --git a/ja/api-reference/openapi_chatflow.json b/ja/api-reference/openapi_chatflow.json index cf1c85557..96f81deda 100644 --- a/ja/api-reference/openapi_chatflow.json +++ b/ja/api-reference/openapi_chatflow.json @@ -498,7 +498,8 @@ "schema": { "type": "object", "required": [ - "file" + "file", + "user" ], "properties": { "file": { @@ -508,7 +509,7 @@ }, "user": { "type": "string", - "description": "ユーザー識別子。開発者のルールで定義され、アプリケーション内で一意である必要があります。" + "description": "ユーザー識別子。開発者のルールで定義され、アプリケーション内で一意である必要があります。Service API と WebApp のユーザー ID は独立しており、値が同じでも同じユーザーを指しません。" } } } diff --git a/ja/api-reference/openapi_completion.json b/ja/api-reference/openapi_completion.json index 05988e331..85c28eb55 100644 --- a/ja/api-reference/openapi_completion.json +++ b/ja/api-reference/openapi_completion.json @@ -443,7 +443,8 @@ "schema": { "type": "object", "required": [ - "file" + "file", + "user" ], "properties": { "file": { @@ -453,7 +454,7 @@ }, "user": { "type": "string", - "description": "ユーザー識別子。開発者のルールで定義され、アプリケーション内で一意である必要があります。" + "description": "ユーザー識別子。開発者のルールで定義され、アプリケーション内で一意である必要があります。Service API と WebApp のユーザー ID は独立しており、値が同じでも同じユーザーを指しません。" } } } diff --git a/ja/api-reference/openapi_workflow.json b/ja/api-reference/openapi_workflow.json index 65ce4712e..a675327d9 100644 --- a/ja/api-reference/openapi_workflow.json +++ b/ja/api-reference/openapi_workflow.json @@ -773,7 +773,8 @@ "schema": { "type": "object", "required": [ - "file" + "file", + "user" ], "properties": { "file": { @@ -783,7 +784,7 @@ }, "user": { "type": "string", - "description": "ユーザー識別子。開発者のルールで定義され、アプリケーション内で一意である必要があります。" + "description": "ユーザー識別子。開発者のルールで定義され、アプリケーション内で一意である必要があります。Service API と WebApp のユーザー ID は独立しており、値が同じでも同じユーザーを指しません。" } } } diff --git a/zh/api-reference/openapi_chat.json b/zh/api-reference/openapi_chat.json index ac6d02e8e..1c5581725 100644 --- a/zh/api-reference/openapi_chat.json +++ b/zh/api-reference/openapi_chat.json @@ -470,7 +470,8 @@ "schema": { "type": "object", "required": [ - "file" + "file", + "user" ], "properties": { "file": { @@ -480,7 +481,7 @@ }, "user": { "type": "string", - "description": "用户标识符,由开发者定义的规则生成,必须在应用内唯一。" + "description": "用户标识符,由开发者定义的规则生成,必须在应用内唯一。Service API 与 WebApp 的用户 ID 相互独立,即使取值相同也不指向同一用户。" } } } diff --git a/zh/api-reference/openapi_chatflow.json b/zh/api-reference/openapi_chatflow.json index b815a39ee..818135278 100644 --- a/zh/api-reference/openapi_chatflow.json +++ b/zh/api-reference/openapi_chatflow.json @@ -498,7 +498,8 @@ "schema": { "type": "object", "required": [ - "file" + "file", + "user" ], "properties": { "file": { @@ -508,7 +509,7 @@ }, "user": { "type": "string", - "description": "用户标识符,由开发者定义的规则生成,必须在应用内唯一。" + "description": "用户标识符,由开发者定义的规则生成,必须在应用内唯一。Service API 与 WebApp 的用户 ID 相互独立,即使取值相同也不指向同一用户。" } } } diff --git a/zh/api-reference/openapi_completion.json b/zh/api-reference/openapi_completion.json index 43bff9e05..c81d75608 100644 --- a/zh/api-reference/openapi_completion.json +++ b/zh/api-reference/openapi_completion.json @@ -443,7 +443,8 @@ "schema": { "type": "object", "required": [ - "file" + "file", + "user" ], "properties": { "file": { @@ -453,7 +454,7 @@ }, "user": { "type": "string", - "description": "用户标识符,由开发者定义的规则生成,必须在应用内唯一。" + "description": "用户标识符,由开发者定义的规则生成,必须在应用内唯一。Service API 与 WebApp 的用户 ID 相互独立,即使取值相同也不指向同一用户。" } } } diff --git a/zh/api-reference/openapi_workflow.json b/zh/api-reference/openapi_workflow.json index 6acc5872e..40b07ebc9 100644 --- a/zh/api-reference/openapi_workflow.json +++ b/zh/api-reference/openapi_workflow.json @@ -773,7 +773,8 @@ "schema": { "type": "object", "required": [ - "file" + "file", + "user" ], "properties": { "file": { @@ -783,7 +784,7 @@ }, "user": { "type": "string", - "description": "用户标识符,由开发者定义的规则生成,必须在应用内唯一。" + "description": "用户标识符,由开发者定义的规则生成,必须在应用内唯一。Service API 与 WebApp 的用户 ID 相互独立,即使取值相同也不指向同一用户。" } } }