refactor: port reqparse to BaseModel

[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

fix #27513

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 dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

[asukaminato0721]

bug:

        parser = (
            reqparse.RequestParser()
            .add_argument("name", type=str, required=False, location="json")
            .add_argument("auto_generate", type=bool, required=False, default=False, location="json")
        )
        args = parser.parse_args()

so name is optional, but ConversationService.rename require name not optional

[asukaminato0721]

/gemini review

[gemini-code-assist]

Code Review

This pull request is a large-scale refactoring to replace reqparse with Pydantic's BaseModel for API payload validation. This is a great improvement for type safety, maintainability, and consistency across the codebase. The changes are well-executed in most places. I've found a couple of potential issues where the logic might have been unintentionally changed during the refactoring, and one place where the refactoring could be applied for better consistency. Overall, this is a solid refactoring that modernizes the API layer.

[Copilot]

Pull request overview

This PR migrates the codebase from Flask-RESTx's reqparse to Pydantic BaseModel for request validation. The refactoring replaces imperative request parsing with declarative schema definitions, improving type safety and validation consistency across all API endpoints. The changes affect service APIs, console APIs, internal APIs, and test files.

Key Changes:

• Created a new controllers/common/schema.py module with helper functions to register Pydantic models with Flask-RESTX namespaces
• Replaced all reqparse.RequestParser() instances with Pydantic BaseModel classes
• Updated test files to remove reqparse dependencies and use Pydantic validation directly
• Modified service method signatures to accept optional parameters with default values

Reviewed changes

Copilot reviewed 44 out of 44 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
api/controllers/common/schema.py	New helper module for registering Pydantic models with Flask-RESTX
api/services/hit_testing_service.py	Added default None values to optional parameters
api/controllers/service_api/dataset/segment.py	Migrated segment operations from reqparse to Pydantic models
api/controllers/service_api/dataset/metadata.py	Migrated metadata operations from reqparse to Pydantic models
api/controllers/service_api/dataset/document.py	Migrated document operations from reqparse to Pydantic models
api/controllers/service_api/dataset/dataset.py	Migrated dataset CRUD and tag operations from reqparse to Pydantic models
api/controllers/service_api/app/workflow.py	Migrated workflow operations from reqparse to Pydantic models
api/controllers/console/datasets/datasets.py	Migrated console dataset operations from reqparse to Pydantic models
Multiple test files	Updated tests to remove reqparse and use Pydantic validation

---

You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

[asukaminato0721]

/gemini review

[gemini-code-assist]

Code Review

This pull request is an excellent and extensive refactoring, migrating request parsing from reqparse to Pydantic BaseModel across a large number of API endpoints. This is a significant improvement for code quality, making the validation logic more declarative, readable, and type-safe. The implementation is very consistent and well-executed.

I've identified a few minor issues, primarily related to the nuances of parsing query parameters with Pydantic, such as handling list-like parameters and optional UUIDs that might be passed as empty strings. I've also suggested an improvement for error handling in a decorator to make it more robust. Other than these points, the refactoring is solid. Great work on this large-scale improvement!

[Copilot]

Pull request overview

Copilot reviewed 44 out of 44 changed files in this pull request and generated no new comments.

---

You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.