refactor: port api/fields/file_fields.py

[asukaminato0721]

Important

1. Make sure you have read our contribution guidelines
2. Ensure there is an associated issue and you have been assigned to it
3. Use the correct syntax to link this PR: Fixes #<issue number>.

Summary

part of #28015

Screenshots

Before	After
...	...

Checklist

• 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 make lint and make type-check (backend) and cd web && npx lint-staged (frontend) to appease the lint gods

[gemini-code-assist]

Summary of Changes

Hello @asukaminato0721, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request undertakes a significant refactoring effort to modernize the API response serialization for file-related functionalities. By migrating from Flask-RestX's native field definitions to Pydantic BaseModels, the change standardizes data structures, improves type safety, and streamlines the generation of API documentation. This ensures a more consistent and robust approach to handling file data across various API endpoints, including console, service, and web interfaces.

Highlights

• Pydantic Migration for File Schemas: Replaced Flask-RestX fields and marshal_with with Pydantic BaseModels for defining and serializing file-related API responses.
• API Endpoint Updates: All relevant file upload and remote file information endpoints were updated to utilize the new Pydantic models for consistent data handling and improved API documentation.
• Enhanced API Documentation: Integrated Pydantic models with Flask-RestX's Swagger documentation via a new register_schema_models utility, providing clearer and more accurate API specifications.
• Improved Type Safety and Maintainability: The transition to Pydantic enhances type hinting and data validation, leading to more robust and maintainable code.
• New Unit Tests: Dedicated unit tests were added for the new Pydantic file schemas to ensure their correct functionality and serialization behavior.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request refactors the API field definitions from flask-restx fields to pydantic models, which is a great improvement for type safety and maintainability. The changes are consistently applied across all relevant controllers, and new tests have been added for the pydantic models. My main feedback is to reduce code duplication in the new pydantic models by using a base class.

[Copilot]

Pull request overview

This PR refactors the file field definitions from Flask-RestX field dictionaries to Pydantic models as part of a larger modernization effort (#28015). The change improves type safety, validation, and maintainability by leveraging Pydantic's features.

• Replaces Flask-RestX field definitions with Pydantic BaseModel classes
• Adds field validators for datetime-to-timestamp conversion
• Updates all controller endpoints to use the new Pydantic models with proper serialization

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
api/fields/file_fields.py	Complete rewrite from Flask-RestX field dictionaries to Pydantic models (FileResponse, FileWithSignedUrl, RemoteFileInfo, UploadConfig)
api/tests/unit_tests/fields/test_file_fields.py	New test file covering Pydantic model serialization and validation
api/tests/unit_tests/controllers/console/test_files_security.py	Updates mock patch paths and adds MethodView to builtins
api/controllers/web/remote_files.py	Migrates from marshal_with to Pydantic model validation and serialization
api/controllers/web/files.py	Migrates from marshal_with to Pydantic model validation and serialization
api/controllers/service_api/app/file.py	Migrates from marshal_with to Pydantic model validation and serialization
api/controllers/files/upload.py	Migrates to Pydantic models, removes some type annotations
api/controllers/console/remote_files.py	Migrates from marshal_with to Pydantic model validation and serialization
api/controllers/console/files.py	Migrates from marshal_with to Pydantic model validation and serialization for both GET and POST endpoints

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.