Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update workflow doc #16251

Merged
merged 1 commit into from
Mar 20, 2025
Merged

Conversation

sorphwer
Copy link
Contributor

Summary

The original file variable has been replaced with a file array, so the doc needs to be updated.

Takeaways:

  1. The original documentation shows a files attribute that does not exist in the current version.
  2. Move the format description inside inputs to make the documentation more straightforward.
  3. Update the data and code examples to use a file array instead of a single file. Otherwise, users will encounter the following error when following the current documentation:
400, {"code": "invalid_param", "message": "XXX in input form must be a list of files", "status": 400}

Screenshots

Before

image image image image image

After

image image image image image

Checklist

Important

Please review the checklist below before submitting your pull request.

  • This change requires a documentation update, included: Dify Document
  • I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. 📚 documentation Improvements or additions to documentation labels Mar 19, 2025
@sorphwer sorphwer changed the title update workflow doc fix: update workflow doc Mar 19, 2025
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Mar 20, 2025
@crazywoola crazywoola merged commit 285314d into langgenius:main Mar 20, 2025
5 checks passed
parambharat pushed a commit to parambharat/dify that referenced this pull request Mar 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants