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

docs: improve api documentation for advanced chat and workflow #9882

Merged
merged 1 commit into from
Oct 26, 2024

Conversation

kurokobo
Copy link
Contributor

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

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. 📚 documentation Improvements or additions to documentation labels Oct 25, 2024
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Oct 26, 2024
@crazywoola crazywoola merged commit 227f49a into langgenius:main Oct 26, 2024
4 checks passed
@kurokobo kurokobo deleted the apidocs branch October 26, 2024 03:51
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.

Improve API documentation for the recent file uploading feature for advanced-chat and workflow
2 participants