langgenius/dify
1
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-07-21 20:15:31 -04:00
Code Issues 775 Packages Projects Releases 10 Wiki Activity

[PR #9882] docs: improve api documentation for advanced chat and workflow #26596

New Issue
Closed
opened 2026-02-21 20:39:53 -05:00 by yindo · 0 comments
yindo commented 2026-02-21 20:39:53 -05:00
Owner
Copy Link
Copy Source

Original Pull Request: https://github.com/langgenius/dify/pull/9882

State: closed
Merged: Yes

Checklist:

Important

Please review the checklist below before submitting your pull request.

  • Please open an issue before creating a PR or link to an existing issue
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

Description

This PR improves API documentation for Advanced Chat App and Workflow App.

Please let me know if my language or translations are incorrect.

  • For Advanced Chat App:
    • Add a brief description to specify a file as one of the inputs to support Single File type or File List type
      image
    • Correct the description regarding the supported file formats for the File Upload API
      image
  • For Workflow App
    • Add a brief description to specify a file as one of the inputs to support Single File type or File List type
      image
    • Add whole File Upload API section with corrected description about supported file format
      image

Follow-Up for #9832 (Thanks @JzoNgKVO)
Fixes #9880

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update, included: Dify Document
  • Improvement, including but not limited to code refactoring, performance optimization, and UI/UX improvement
  • Dependency upgrade

Testing Instructions

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Deploy customized web image on Docker and ensure new docs are displayed in API Access page for the chatflow and workflow
**Original Pull Request:** https://github.com/langgenius/dify/pull/9882 **State:** closed **Merged:** Yes --- # Checklist: > [!IMPORTANT] > Please review the checklist below before submitting your pull request. - [x] Please open an issue before creating a PR or link to an existing issue - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I ran `dev/reformat`(backend) and `cd web && npx lint-staged`(frontend) to appease the lint gods # Description This PR improves API documentation for Advanced Chat App and Workflow App. Please let me know if my language or translations are incorrect. - For Advanced Chat App: - Add a brief description to specify a file as one of the `inputs` to support `Single File` type or `File List` type ![image](https://github.com/user-attachments/assets/bac0adf1-799f-45f3-b3ff-faebbac05382) - Correct the description regarding the supported file formats for the File Upload API ![image](https://github.com/user-attachments/assets/eebb94a8-d35e-46b6-9821-44cd251fee88) - For Workflow App - Add a brief description to specify a file as one of the `inputs` to support `Single File` type or `File List` type ![image](https://github.com/user-attachments/assets/790031b2-2a44-456a-86ed-82c9f89d7ea3) - Add whole File Upload API section with corrected description about supported file format ![image](https://github.com/user-attachments/assets/27630f5b-7043-4c7d-aa0d-47f42e250d86) Follow-Up for #9832 (Thanks @JzoNgKVO) Fixes #9880 ## Type of Change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update, included: [Dify Document](https://github.com/langgenius/dify-docs) - [x] Improvement, including but not limited to code refactoring, performance optimization, and UI/UX improvement - [ ] Dependency upgrade # Testing Instructions Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration - [x] Deploy customized web image on Docker and ensure new docs are displayed in `API Access` page for the chatflow and workflow
yindo added the pull-request label 2026-02-21 20:39:53 -05:00
yindo closed this issue 2026-02-21 20:39:53 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Knowledge Pipeline
Proposal
WIP
cloud
dependencies
feat:webapp
good first issue
outdated
performance
pull-request
Mirrored from GitHub Pull Request
 python:uv
refactor
size:L
stale
status: accepting prs
status: blocked
status: in discussion
stt & tts
vulnerablity
web
wont-fix
🌊 feat:workflow
🌚 invalid
🐞 bug
👻 feat:rag
💪 enhancement
📚 documentation
🔨 feat:tools
🙋‍♂️ question
🙏 help wanted
🤔 cant-reproduce
🤖 feat:agent
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#26596
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?