docs: require user for file upload API (#794)

laipz8200 · RiskeyL · laipz8200 · commit 9cca6e10b22f · 2026-05-28T04:51:17.000Z
* 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 9b82c3e)
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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 相互独立，即使取值相同也不指向同一用户。"
                   }
                 }
               }

Original file line number	Diff line number	Diff line change
`@@ -470,7 +470,8 @@`
`470`	`470`	`"schema": {`
`471`	`471`	`"type": "object",`
`472`	`472`	`"required": [`
`473`		`- "file"`
	`473`	`+ "file",`
	`474`	`+ "user"`
`474`	`475`	`],`
`475`	`476`	`"properties": {`
`476`	`477`	`"file": {`
`@@ -480,7 +481,7 @@`
`480`	`481`	`},`
`481`	`482`	`"user": {`
`482`	`483`	`"type": "string",`
`483`		`- "description": "User identifier, defined by the developer's rules, must be unique within the application."`
	`484`	`+ "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."`
`484`	`485`	`}`
`485`	`486`	`}`
`486`	`487`	`}`
Original file line number	Diff line number	Diff line change
`@@ -498,7 +498,8 @@`
`498`	`498`	`"schema": {`
`499`	`499`	`"type": "object",`
`500`	`500`	`"required": [`
`501`		`- "file"`
	`501`	`+ "file",`
	`502`	`+ "user"`
`502`	`503`	`],`
`503`	`504`	`"properties": {`
`504`	`505`	`"file": {`
`@@ -508,7 +509,7 @@`
`508`	`509`	`},`
`509`	`510`	`"user": {`
`510`	`511`	`"type": "string",`
`511`		`- "description": "User identifier, defined by the developer's rules, must be unique within the application."`
	`512`	`+ "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."`
`512`	`513`	`}`
`513`	`514`	`}`
`514`	`515`	`}`
Original file line number	Diff line number	Diff line change
`@@ -443,7 +443,8 @@`
`443`	`443`	`"schema": {`
`444`	`444`	`"type": "object",`
`445`	`445`	`"required": [`
`446`		`- "file"`
	`446`	`+ "file",`
	`447`	`+ "user"`
`447`	`448`	`],`
`448`	`449`	`"properties": {`
`449`	`450`	`"file": {`
`@@ -453,7 +454,7 @@`
`453`	`454`	`},`
`454`	`455`	`"user": {`
`455`	`456`	`"type": "string",`
`456`		`- "description": "User identifier, defined by the developer's rules, must be unique within the application."`
	`457`	`+ "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."`
`457`	`458`	`}`
`458`	`459`	`}`
`459`	`460`	`}`
Original file line number	Diff line number	Diff line change
`@@ -773,7 +773,8 @@`
`773`	`773`	`"schema": {`
`774`	`774`	`"type": "object",`
`775`	`775`	`"required": [`
`776`		`- "file"`
	`776`	`+ "file",`
	`777`	`+ "user"`
`777`	`778`	`],`
`778`	`779`	`"properties": {`
`779`	`780`	`"file": {`
`@@ -783,7 +784,7 @@`
`783`	`784`	`},`
`784`	`785`	`"user": {`
`785`	`786`	`"type": "string",`
`786`		`- "description": "User identifier, defined by the developer's rules, must be unique within the application."`
	`787`	`+ "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."`
`787`	`788`	`}`
`788`	`789`	`}`
`789`	`790`	`}`