chore: unify api && clean some type ignore#35984
Merged
Merged
Conversation
Contributor
Pyrefly Type Coverage
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR standardizes how Pydantic models/enums are registered into Flask-RESTX namespaces for Swagger/OpenAPI generation, and removes a number of # type: ignore suppressions around query parsing/validation in API controllers.
Changes:
- Replaced repeated per-file
schema_model(...model_json_schema(ref_template=...))blocks with shared helpers (register_schema_models,register_enum_models). - Removed duplicated
DEFAULT_REF_TEMPLATE_SWAGGER_2_0constants from many controllers. - Cleaned up request arg parsing by removing unnecessary
# type: ignoreonmodel_validate(request.args.to_dict(...)).
Reviewed changes
Copilot reviewed 39 out of 39 changed files in this pull request and generated 31 comments.
Show a summary per file
| File | Description |
|---|---|
| api/controllers/service_api/dataset/document.py | Removes redundant Swagger ref-template constant. |
| api/controllers/service_api/dataset/dataset.py | Switches enum schema registration to register_enum_models. |
| api/controllers/files/upload.py | Uses shared schema-registration helper; removes type-ignore on query validation. |
| api/controllers/files/tool_files.py | Uses register_schema_models for query model registration. |
| api/controllers/files/image_preview.py | Uses register_schema_models; removes type-ignores on query validation. |
| api/controllers/console/workspace/workspace.py | Replaces local schema registration helper with register_schema_models. |
| api/controllers/console/workspace/plugin.py | Removes type-ignores on query validation. |
| api/controllers/console/workspace/models.py | Consolidates schema registrations; removes type-ignores on query validation. |
| api/controllers/console/workspace/model_providers.py | Replaces local schema registration helper with register_schema_models. |
| api/controllers/console/workspace/members.py | Consolidates payload schema registrations and enum registration. |
| api/controllers/console/workspace/endpoint.py | Uses register_schema_models; removes legacy per-model registration helper. |
| api/controllers/console/workspace/account.py | Consolidates schema registrations; removes type-ignore on query validation. |
| api/controllers/console/extension.py | Removes type-ignore on query validation. |
| api/controllers/console/explore/trial.py | Uses register_schema_models for request model docs. |
| api/controllers/console/explore/recommended_app.py | Removes type-ignore on query validation. |
| api/controllers/console/datasets/rag_pipeline/datasource_content_preview.py | Uses register_schema_models for payload docs. |
| api/controllers/console/auth/login.py | Uses register_schema_models for auth payload docs. |
| api/controllers/console/auth/forgot_password.py | Removes redundant Swagger ref-template constant. |
| api/controllers/console/auth/email_register.py | Uses register_schema_models for register payload docs. |
| api/controllers/console/auth/data_source_bearer_auth.py | Uses register_schema_models for payload docs. |
| api/controllers/console/auth/activate.py | Removes type-ignore on query validation. |
| api/controllers/console/app/workflow.py | Removes redundant Swagger ref-template constant; removes type-ignore on query validation. |
| api/controllers/console/app/workflow_trigger.py | Removes type-ignore on query validation. |
| api/controllers/console/app/workflow_statistic.py | Uses register_schema_models; removes type-ignores on query validation. |
| api/controllers/console/app/workflow_run.py | Removes type-ignores on query validation. |
| api/controllers/console/app/workflow_draft_variable.py | Uses register_schema_models; removes type-ignore on query validation. |
| api/controllers/console/app/workflow_comment.py | Consolidates schema registration into register_schema_models. |
| api/controllers/console/app/workflow_app_log.py | Removes type-ignores on query validation. |
| api/controllers/console/app/statistic.py | Uses register_schema_models; removes type-ignores on query validation. |
| api/controllers/console/app/ops_trace.py | Uses register_schema_models; removes type-ignores on query validation. |
| api/controllers/console/app/conversation.py | Uses register_schema_models; removes duplicated legacy schema_model blocks. |
| api/controllers/console/app/conversation_variables.py | Removes type-ignore on query validation. |
| api/controllers/console/app/completion.py | Uses register_schema_models for request model docs. |
| api/controllers/console/app/audio.py | Removes type-ignore on query validation. |
| api/controllers/console/app/app.py | Removes type-ignore on query validation. |
| api/controllers/console/app/annotation.py | Consolidates schema registration into register_schema_models. |
| api/controllers/console/app/agent.py | Uses register_schema_models; removes type-ignore on query validation. |
| api/controllers/console/app/advanced_prompt_template.py | Removes type-ignore on query validation. |
| api/controllers/console/admin.py | Uses register_schema_models for admin payload docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Pyrefly Diffbase → PR--- /tmp/pyrefly_base.txt 2026-05-09 18:37:42.662560535 +0000
+++ /tmp/pyrefly_pr.txt 2026-05-09 18:37:31.133512006 +0000
@@ -7,7 +7,7 @@
ERROR Object of class `App` has no attribute `access_mode` [missing-attribute]
--> controllers/console/app/app.py:574:13
ERROR Argument `str | None` is not assignable to parameter `language` with type `str` in function `services.account_service.AccountService.send_email_register_email` [bad-argument-type]
- --> controllers/console/auth/email_register.py:75:108
+ --> controllers/console/auth/email_register.py:73:108
ERROR Object of class `MissingRouter` has no attribute `get` [missing-attribute]
--> controllers/console/init_validate.py:31:2
ERROR Object of class `MissingRouter` has no attribute `post` [missing-attribute]
|
WH-2099
approved these changes
May 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Important
Fixes #<issue number>.Summary
Screenshots
Checklist
make lint && make type-check(backend) andcd web && pnpm exec vp staged(frontend) to appease the lint gods