refactor: port reqparse to Pydantic model (#28913)

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

api/controllers/console/workspace/account.py

@@ -174,63 +174,25 @@ class CheckEmailUniquePayload(BaseModel):
         return email(value)
 
 
-console_ns.schema_model(
-    AccountInitPayload.__name__, AccountInitPayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
-console_ns.schema_model(
-    AccountNamePayload.__name__, AccountNamePayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
-console_ns.schema_model(
-    AccountAvatarPayload.__name__, AccountAvatarPayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
-console_ns.schema_model(
-    AccountInterfaceLanguagePayload.__name__,
-    AccountInterfaceLanguagePayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    AccountInterfaceThemePayload.__name__,
-    AccountInterfaceThemePayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    AccountTimezonePayload.__name__,
-    AccountTimezonePayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    AccountPasswordPayload.__name__,
-    AccountPasswordPayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    AccountDeletePayload.__name__,
-    AccountDeletePayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    AccountDeletionFeedbackPayload.__name__,
-    AccountDeletionFeedbackPayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    EducationActivatePayload.__name__,
-    EducationActivatePayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    EducationAutocompleteQuery.__name__,
-    EducationAutocompleteQuery.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    ChangeEmailSendPayload.__name__,
-    ChangeEmailSendPayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    ChangeEmailValidityPayload.__name__,
-    ChangeEmailValidityPayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    ChangeEmailResetPayload.__name__,
-    ChangeEmailResetPayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    CheckEmailUniquePayload.__name__,
-    CheckEmailUniquePayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
+def reg(cls: type[BaseModel]):
+    console_ns.schema_model(cls.__name__, cls.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0))
+
+
+reg(AccountInitPayload)
+reg(AccountNamePayload)
+reg(AccountAvatarPayload)
+reg(AccountInterfaceLanguagePayload)
+reg(AccountInterfaceThemePayload)
+reg(AccountTimezonePayload)
+reg(AccountPasswordPayload)
+reg(AccountDeletePayload)
+reg(AccountDeletionFeedbackPayload)
+reg(EducationActivatePayload)
+reg(EducationAutocompleteQuery)
+reg(ChangeEmailSendPayload)
+reg(ChangeEmailValidityPayload)
+reg(ChangeEmailResetPayload)
+reg(CheckEmailUniquePayload)
 
 
 @console_ns.route("/account/init")

api/controllers/console/workspace/endpoint.py

@@ -1,4 +1,8 @@
-from flask_restx import Resource, fields, reqparse
+from typing import Any
+
+from flask import request
+from flask_restx import Resource, fields
+from pydantic import BaseModel, Field
 
 from controllers.console import console_ns
 from controllers.console.wraps import account_initialization_required, is_admin_or_owner_required, setup_required
@@ -7,21 +11,49 @@ from core.plugin.impl.exc import PluginPermissionDeniedError
 from libs.login import current_account_with_tenant, login_required
 from services.plugin.endpoint_service import EndpointService
 
+DEFAULT_REF_TEMPLATE_SWAGGER_2_0 = "#/definitions/{model}"
+
+
+class EndpointCreatePayload(BaseModel):
+    plugin_unique_identifier: str
+    settings: dict[str, Any]
+    name: str = Field(min_length=1)
+
+
+class EndpointIdPayload(BaseModel):
+    endpoint_id: str
+
+
+class EndpointUpdatePayload(EndpointIdPayload):
+    settings: dict[str, Any]
+    name: str = Field(min_length=1)
+
+
+class EndpointListQuery(BaseModel):
+    page: int = Field(ge=1)
+    page_size: int = Field(gt=0)
+
+
+class EndpointListForPluginQuery(EndpointListQuery):
+    plugin_id: str
+
+
+def reg(cls: type[BaseModel]):
+    console_ns.schema_model(cls.__name__, cls.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0))
+
+
+reg(EndpointCreatePayload)
+reg(EndpointIdPayload)
+reg(EndpointUpdatePayload)
+reg(EndpointListQuery)
+reg(EndpointListForPluginQuery)
+
 
 @console_ns.route("/workspaces/current/endpoints/create")
 class EndpointCreateApi(Resource):
     @console_ns.doc("create_endpoint")
     @console_ns.doc(description="Create a new plugin endpoint")
-    @console_ns.expect(
-        console_ns.model(
-            "EndpointCreateRequest",
-            {
-                "plugin_unique_identifier": fields.String(required=True, description="Plugin unique identifier"),
-                "settings": fields.Raw(required=True, description="Endpoint settings"),
-                "name": fields.String(required=True, description="Endpoint name"),
-            },
-        )
-    )
+    @console_ns.expect(console_ns.models[EndpointCreatePayload.__name__])
     @console_ns.response(
         200,
         "Endpoint created successfully",
@@ -35,26 +67,16 @@ class EndpointCreateApi(Resource):
     def post(self):
         user, tenant_id = current_account_with_tenant()
 
-        parser = (
-            reqparse.RequestParser()
-            .add_argument("plugin_unique_identifier", type=str, required=True)
-            .add_argument("settings", type=dict, required=True)
-            .add_argument("name", type=str, required=True)
-        )
-        args = parser.parse_args()
-
-        plugin_unique_identifier = args["plugin_unique_identifier"]
-        settings = args["settings"]
-        name = args["name"]
+        args = EndpointCreatePayload.model_validate(console_ns.payload)
 
         try:
             return {
                 "success": EndpointService.create_endpoint(
                     tenant_id=tenant_id,
                     user_id=user.id,
-                    plugin_unique_identifier=plugin_unique_identifier,
-                    name=name,
-                    settings=settings,
+                    plugin_unique_identifier=args.plugin_unique_identifier,
+                    name=args.name,
+                    settings=args.settings,
                 )
             }
         except PluginPermissionDeniedError as e:
@@ -65,11 +87,7 @@ class EndpointCreateApi(Resource):
 class EndpointListApi(Resource):
     @console_ns.doc("list_endpoints")
     @console_ns.doc(description="List plugin endpoints with pagination")
-    @console_ns.expect(
-        console_ns.parser()
-        .add_argument("page", type=int, required=True, location="args", help="Page number")
-        .add_argument("page_size", type=int, required=True, location="args", help="Page size")
-    )
+    @console_ns.expect(console_ns.models[EndpointListQuery.__name__])
     @console_ns.response(
         200,
         "Success",
@@ -83,15 +101,10 @@ class EndpointListApi(Resource):
     def get(self):
         user, tenant_id = current_account_with_tenant()
 
-        parser = (
-            reqparse.RequestParser()
-            .add_argument("page", type=int, required=True, location="args")
-            .add_argument("page_size", type=int, required=True, location="args")
-        )
-        args = parser.parse_args()
+        args = EndpointListQuery.model_validate(request.args.to_dict(flat=True))  # type: ignore
 
-        page = args["page"]
-        page_size = args["page_size"]
+        page = args.page
+        page_size = args.page_size
 
         return jsonable_encoder(
             {
@@ -109,12 +122,7 @@ class EndpointListApi(Resource):
 class EndpointListForSinglePluginApi(Resource):
     @console_ns.doc("list_plugin_endpoints")
     @console_ns.doc(description="List endpoints for a specific plugin")
-    @console_ns.expect(
-        console_ns.parser()
-        .add_argument("page", type=int, required=True, location="args", help="Page number")
-        .add_argument("page_size", type=int, required=True, location="args", help="Page size")
-        .add_argument("plugin_id", type=str, required=True, location="args", help="Plugin ID")
-    )
+    @console_ns.expect(console_ns.models[EndpointListForPluginQuery.__name__])
     @console_ns.response(
         200,
         "Success",
@@ -128,17 +136,11 @@ class EndpointListForSinglePluginApi(Resource):
     def get(self):
         user, tenant_id = current_account_with_tenant()
 
-        parser = (
-            reqparse.RequestParser()
-            .add_argument("page", type=int, required=True, location="args")
-            .add_argument("page_size", type=int, required=True, location="args")
-            .add_argument("plugin_id", type=str, required=True, location="args")
-        )
-        args = parser.parse_args()
+        args = EndpointListForPluginQuery.model_validate(request.args.to_dict(flat=True))  # type: ignore
 
-        page = args["page"]
-        page_size = args["page_size"]
-        plugin_id = args["plugin_id"]
+        page = args.page
+        page_size = args.page_size
+        plugin_id = args.plugin_id
 
         return jsonable_encoder(
             {
@@ -157,11 +159,7 @@ class EndpointListForSinglePluginApi(Resource):
 class EndpointDeleteApi(Resource):
     @console_ns.doc("delete_endpoint")
     @console_ns.doc(description="Delete a plugin endpoint")
-    @console_ns.expect(
-        console_ns.model(
-            "EndpointDeleteRequest", {"endpoint_id": fields.String(required=True, description="Endpoint ID")}
-        )
-    )
+    @console_ns.expect(console_ns.models[EndpointIdPayload.__name__])
     @console_ns.response(
         200,
         "Endpoint deleted successfully",
@@ -175,13 +173,12 @@ class EndpointDeleteApi(Resource):
     def post(self):
         user, tenant_id = current_account_with_tenant()
 
-        parser = reqparse.RequestParser().add_argument("endpoint_id", type=str, required=True)
-        args = parser.parse_args()
-
-        endpoint_id = args["endpoint_id"]
+        args = EndpointIdPayload.model_validate(console_ns.payload)
 
         return {
-            "success": EndpointService.delete_endpoint(tenant_id=tenant_id, user_id=user.id, endpoint_id=endpoint_id)
+            "success": EndpointService.delete_endpoint(
+                tenant_id=tenant_id, user_id=user.id, endpoint_id=args.endpoint_id
+            )
         }
 
 
@@ -189,16 +186,7 @@ class EndpointDeleteApi(Resource):
 class EndpointUpdateApi(Resource):
     @console_ns.doc("update_endpoint")
     @console_ns.doc(description="Update a plugin endpoint")
-    @console_ns.expect(
-        console_ns.model(
-            "EndpointUpdateRequest",
-            {
-                "endpoint_id": fields.String(required=True, description="Endpoint ID"),
-                "settings": fields.Raw(required=True, description="Updated settings"),
-                "name": fields.String(required=True, description="Updated name"),
-            },
-        )
-    )
+    @console_ns.expect(console_ns.models[EndpointUpdatePayload.__name__])
     @console_ns.response(
         200,
         "Endpoint updated successfully",
@@ -212,25 +200,15 @@ class EndpointUpdateApi(Resource):
     def post(self):
         user, tenant_id = current_account_with_tenant()
 
-        parser = (
-            reqparse.RequestParser()
-            .add_argument("endpoint_id", type=str, required=True)
-            .add_argument("settings", type=dict, required=True)
-            .add_argument("name", type=str, required=True)
-        )
-        args = parser.parse_args()
-
-        endpoint_id = args["endpoint_id"]
-        settings = args["settings"]
-        name = args["name"]
+        args = EndpointUpdatePayload.model_validate(console_ns.payload)
 
         return {
             "success": EndpointService.update_endpoint(
                 tenant_id=tenant_id,
                 user_id=user.id,
-                endpoint_id=endpoint_id,
-                name=name,
-                settings=settings,
+                endpoint_id=args.endpoint_id,
+                name=args.name,
+                settings=args.settings,
             )
         }
 
@@ -239,11 +217,7 @@ class EndpointUpdateApi(Resource):
 class EndpointEnableApi(Resource):
     @console_ns.doc("enable_endpoint")
     @console_ns.doc(description="Enable a plugin endpoint")
-    @console_ns.expect(
-        console_ns.model(
-            "EndpointEnableRequest", {"endpoint_id": fields.String(required=True, description="Endpoint ID")}
-        )
-    )
+    @console_ns.expect(console_ns.models[EndpointIdPayload.__name__])
     @console_ns.response(
         200,
         "Endpoint enabled successfully",
@@ -257,13 +231,12 @@ class EndpointEnableApi(Resource):
     def post(self):
         user, tenant_id = current_account_with_tenant()
 
-        parser = reqparse.RequestParser().add_argument("endpoint_id", type=str, required=True)
-        args = parser.parse_args()
-
-        endpoint_id = args["endpoint_id"]
+        args = EndpointIdPayload.model_validate(console_ns.payload)
 
         return {
-            "success": EndpointService.enable_endpoint(tenant_id=tenant_id, user_id=user.id, endpoint_id=endpoint_id)
+            "success": EndpointService.enable_endpoint(
+                tenant_id=tenant_id, user_id=user.id, endpoint_id=args.endpoint_id
+            )
         }
 
 
@@ -271,11 +244,7 @@ class EndpointEnableApi(Resource):
 class EndpointDisableApi(Resource):
     @console_ns.doc("disable_endpoint")
     @console_ns.doc(description="Disable a plugin endpoint")
-    @console_ns.expect(
-        console_ns.model(
-            "EndpointDisableRequest", {"endpoint_id": fields.String(required=True, description="Endpoint ID")}
-        )
-    )
+    @console_ns.expect(console_ns.models[EndpointIdPayload.__name__])
     @console_ns.response(
         200,
         "Endpoint disabled successfully",
@@ -289,11 +258,10 @@ class EndpointDisableApi(Resource):
     def post(self):
         user, tenant_id = current_account_with_tenant()
 
-        parser = reqparse.RequestParser().add_argument("endpoint_id", type=str, required=True)
-        args = parser.parse_args()
-
-        endpoint_id = args["endpoint_id"]
+        args = EndpointIdPayload.model_validate(console_ns.payload)
 
         return {
-            "success": EndpointService.disable_endpoint(tenant_id=tenant_id, user_id=user.id, endpoint_id=endpoint_id)
+            "success": EndpointService.disable_endpoint(
+                tenant_id=tenant_id, user_id=user.id, endpoint_id=args.endpoint_id
+            )
         }

api/controllers/console/workspace/members.py

@@ -58,26 +58,15 @@ class OwnerTransferPayload(BaseModel):
     token: str
 
 
-console_ns.schema_model(
-    MemberInvitePayload.__name__,
-    MemberInvitePayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    MemberRoleUpdatePayload.__name__,
-    MemberRoleUpdatePayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    OwnerTransferEmailPayload.__name__,
-    OwnerTransferEmailPayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    OwnerTransferCheckPayload.__name__,
-    OwnerTransferCheckPayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-console_ns.schema_model(
-    OwnerTransferPayload.__name__,
-    OwnerTransferPayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
+def reg(cls: type[BaseModel]):
+    console_ns.schema_model(cls.__name__, cls.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0))
+
+
+reg(MemberInvitePayload)
+reg(MemberRoleUpdatePayload)
+reg(OwnerTransferEmailPayload)
+reg(OwnerTransferCheckPayload)
+reg(OwnerTransferPayload)
 
 
 @console_ns.route("/workspaces/current/members")

api/controllers/console/workspace/model_providers.py

@@ -75,44 +75,18 @@ class ParserPreferredProviderType(BaseModel):
     preferred_provider_type: Literal["system", "custom"]
 
 
-console_ns.schema_model(
-    ParserModelList.__name__, ParserModelList.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
+def reg(cls: type[BaseModel]):
+    console_ns.schema_model(cls.__name__, cls.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0))
 
-console_ns.schema_model(
-    ParserCredentialId.__name__,
-    ParserCredentialId.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
 
-console_ns.schema_model(
-    ParserCredentialCreate.__name__,
-    ParserCredentialCreate.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserCredentialUpdate.__name__,
-    ParserCredentialUpdate.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserCredentialDelete.__name__,
-    ParserCredentialDelete.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserCredentialSwitch.__name__,
-    ParserCredentialSwitch.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserCredentialValidate.__name__,
-    ParserCredentialValidate.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserPreferredProviderType.__name__,
-    ParserPreferredProviderType.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
+reg(ParserModelList)
+reg(ParserCredentialId)
+reg(ParserCredentialCreate)
+reg(ParserCredentialUpdate)
+reg(ParserCredentialDelete)
+reg(ParserCredentialSwitch)
+reg(ParserCredentialValidate)
+reg(ParserPreferredProviderType)
 
 
 @console_ns.route("/workspaces/current/model-providers")

api/controllers/console/workspace/models.py

@@ -32,25 +32,11 @@ class ParserPostDefault(BaseModel):
     model_settings: list[Inner]
 
 
-console_ns.schema_model(
-    ParserGetDefault.__name__, ParserGetDefault.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
-
-console_ns.schema_model(
-    ParserPostDefault.__name__, ParserPostDefault.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
-
-
 class ParserDeleteModels(BaseModel):
     model: str
     model_type: ModelType
 
 
-console_ns.schema_model(
-    ParserDeleteModels.__name__, ParserDeleteModels.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
-
-
 class LoadBalancingPayload(BaseModel):
     configs: list[dict[str, Any]] | None = None
     enabled: bool | None = None
@@ -119,33 +105,19 @@ class ParserParameter(BaseModel):
     model: str
 
 
-console_ns.schema_model(
-    ParserPostModels.__name__, ParserPostModels.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
+def reg(cls: type[BaseModel]):
+    console_ns.schema_model(cls.__name__, cls.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0))
 
-console_ns.schema_model(
-    ParserGetCredentials.__name__,
-    ParserGetCredentials.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
 
-console_ns.schema_model(
-    ParserCreateCredential.__name__,
-    ParserCreateCredential.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserUpdateCredential.__name__,
-    ParserUpdateCredential.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserDeleteCredential.__name__,
-    ParserDeleteCredential.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserParameter.__name__, ParserParameter.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
+reg(ParserGetDefault)
+reg(ParserPostDefault)
+reg(ParserDeleteModels)
+reg(ParserPostModels)
+reg(ParserGetCredentials)
+reg(ParserCreateCredential)
+reg(ParserUpdateCredential)
+reg(ParserDeleteCredential)
+reg(ParserParameter)
 
 
 @console_ns.route("/workspaces/current/default-model")

api/controllers/console/workspace/plugin.py

@@ -22,6 +22,10 @@ from services.plugin.plugin_service import PluginService
 DEFAULT_REF_TEMPLATE_SWAGGER_2_0 = "#/definitions/{model}"
 
 
+def reg(cls: type[BaseModel]):
+    console_ns.schema_model(cls.__name__, cls.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0))
+
+
 @console_ns.route("/workspaces/current/plugin/debugging-key")
 class PluginDebuggingKeyApi(Resource):
     @setup_required
@@ -46,9 +50,7 @@ class ParserList(BaseModel):
     page_size: int = Field(default=256)
 
 
-console_ns.schema_model(
-    ParserList.__name__, ParserList.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
+reg(ParserList)
 
 
 @console_ns.route("/workspaces/current/plugin/list")
@@ -72,11 +74,6 @@ class ParserLatest(BaseModel):
     plugin_ids: list[str]
 
 
-console_ns.schema_model(
-    ParserLatest.__name__, ParserLatest.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
-
-
 class ParserIcon(BaseModel):
     tenant_id: str
     filename: str
@@ -173,72 +170,22 @@ class ParserReadme(BaseModel):
     language: str = Field(default="en-US")
 
 
-console_ns.schema_model(
-    ParserIcon.__name__, ParserIcon.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
-
-console_ns.schema_model(
-    ParserAsset.__name__, ParserAsset.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
-
-console_ns.schema_model(
-    ParserGithubUpload.__name__, ParserGithubUpload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
-
-console_ns.schema_model(
-    ParserPluginIdentifiers.__name__,
-    ParserPluginIdentifiers.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserGithubInstall.__name__, ParserGithubInstall.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
-
-console_ns.schema_model(
-    ParserPluginIdentifierQuery.__name__,
-    ParserPluginIdentifierQuery.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserTasks.__name__, ParserTasks.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
-
-console_ns.schema_model(
-    ParserMarketplaceUpgrade.__name__,
-    ParserMarketplaceUpgrade.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserGithubUpgrade.__name__, ParserGithubUpgrade.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
-
-console_ns.schema_model(
-    ParserUninstall.__name__, ParserUninstall.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
-
-console_ns.schema_model(
-    ParserPermissionChange.__name__,
-    ParserPermissionChange.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserDynamicOptions.__name__,
-    ParserDynamicOptions.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserPreferencesChange.__name__,
-    ParserPreferencesChange.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserExcludePlugin.__name__,
-    ParserExcludePlugin.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    ParserReadme.__name__, ParserReadme.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
+reg(ParserLatest)
+reg(ParserIcon)
+reg(ParserAsset)
+reg(ParserGithubUpload)
+reg(ParserPluginIdentifiers)
+reg(ParserGithubInstall)
+reg(ParserPluginIdentifierQuery)
+reg(ParserTasks)
+reg(ParserMarketplaceUpgrade)
+reg(ParserGithubUpgrade)
+reg(ParserUninstall)
+reg(ParserPermissionChange)
+reg(ParserDynamicOptions)
+reg(ParserPreferencesChange)
+reg(ParserExcludePlugin)
+reg(ParserReadme)
 
 
 @console_ns.route("/workspaces/current/plugin/list/latest-versions")

api/controllers/console/workspace/workspace.py

@@ -54,25 +54,14 @@ class WorkspaceInfoPayload(BaseModel):
     name: str
 
 
-console_ns.schema_model(
-    WorkspaceListQuery.__name__, WorkspaceListQuery.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0)
-)
+def reg(cls: type[BaseModel]):
+    console_ns.schema_model(cls.__name__, cls.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0))
 
-console_ns.schema_model(
-    SwitchWorkspacePayload.__name__,
-    SwitchWorkspacePayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    WorkspaceCustomConfigPayload.__name__,
-    WorkspaceCustomConfigPayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
-
-console_ns.schema_model(
-    WorkspaceInfoPayload.__name__,
-    WorkspaceInfoPayload.model_json_schema(ref_template=DEFAULT_REF_TEMPLATE_SWAGGER_2_0),
-)
 
+reg(WorkspaceListQuery)
+reg(SwitchWorkspacePayload)
+reg(WorkspaceCustomConfigPayload)
+reg(WorkspaceInfoPayload)
 
 provider_fields = {
     "provider_name": fields.String,