docs: require user for file upload API (#794) (backport to release/1.14.2)#797
Merged
Merged
Conversation
* 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)
dosubot
Bot
added
the
size:XS
Contributor
There was a problem hiding this comment.
Pull request overview
Backports documentation updates to release/1.14.2 to make the /files/upload request contract consistent across Chat, Chatflow, Completion, and Workflow API OpenAPI specs by requiring the user field and clarifying its semantics.
Changes:
- Mark
useras a required field (alongsidefile) in the multipart/files/uploadrequest schema across app API specs. - Expand the
userfield description to clarify uniqueness and that Service API vs WebApp user IDs are independent. - Apply the same contract update across EN / ZH / JA OpenAPI reference JSON files.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| zh/api-reference/openapi_workflow.json | Require user for /files/upload and clarify user semantics (ZH). |
| zh/api-reference/openapi_completion.json | Require user for /files/upload and clarify user semantics (ZH). |
| zh/api-reference/openapi_chatflow.json | Require user for /files/upload and clarify user semantics (ZH). |
| zh/api-reference/openapi_chat.json | Require user for /files/upload and clarify user semantics (ZH). |
| ja/api-reference/openapi_workflow.json | Require user for /files/upload and clarify user semantics (JA). |
| ja/api-reference/openapi_completion.json | Require user for /files/upload and clarify user semantics (JA). |
| ja/api-reference/openapi_chatflow.json | Require user for /files/upload and clarify user semantics (JA). |
| ja/api-reference/openapi_chat.json | Require user for /files/upload and clarify user semantics (JA). |
| en/api-reference/openapi_workflow.json | Require user for /files/upload and clarify user semantics (EN). |
| en/api-reference/openapi_completion.json | Require user for /files/upload and clarify user semantics (EN). |
| en/api-reference/openapi_chatflow.json | Require user for /files/upload and clarify user semantics (EN). |
| en/api-reference/openapi_chat.json | Require user for /files/upload and clarify user semantics (EN). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
RiskeyL
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
maintorelease/1.14.2: