api -> console_ns (#28246)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-11-24 11:04:11 +09:00
parent c75a4e6309
commit e0824c2d93
57 changed files with 1354 additions and 1306 deletions
--- a/api/controllers/console/app/app.py
+++ b/api/controllers/console/app/app.py
@@ -5,7 +5,7 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from werkzeug.exceptions import BadRequest, abort

-from controllers.console import api, console_ns
+from controllers.console import console_ns
 from controllers.console.app.wraps import get_app_model
 from controllers.console.wraps import (
    account_initialization_required,
@@ -32,10 +32,10 @@ ALLOW_CREATE_APP_MODES = ["chat", "agent-chat", "advanced-chat", "workflow", "co

@console_ns.route("/apps")
 class AppListApi(Resource):
-    @api.doc("list_apps")
-    @api.doc(description="Get list of applications with pagination and filtering")
-    @api.expect(
-        api.parser()
+    @console_ns.doc("list_apps")
+    @console_ns.doc(description="Get list of applications with pagination and filtering")
+    @console_ns.expect(
+        console_ns.parser()
        .add_argument("page", type=int, location="args", help="Page number (1-99999)", default=1)
        .add_argument("limit", type=int, location="args", help="Page size (1-100)", default=20)
        .add_argument(
@@ -50,7 +50,7 @@ class AppListApi(Resource):
        .add_argument("tag_ids", type=str, location="args", help="Comma-separated tag IDs")
        .add_argument("is_created_by_me", type=bool, location="args", help="Filter by creator")
    )
-    @api.response(200, "Success", app_pagination_fields)
+    @console_ns.response(200, "Success", app_pagination_fields)
    @setup_required
    @login_required
    @account_initialization_required
@@ -139,10 +139,10 @@ class AppListApi(Resource):

        return marshal(app_pagination, app_pagination_fields), 200

-    @api.doc("create_app")
-    @api.doc(description="Create a new application")
-    @api.expect(
-        api.model(
+    @console_ns.doc("create_app")
+    @console_ns.doc(description="Create a new application")
+    @console_ns.expect(
+        console_ns.model(
            "CreateAppRequest",
            {
                "name": fields.String(required=True, description="App name"),
@@ -154,9 +154,9 @@ class AppListApi(Resource):
            },
        )
    )
-    @api.response(201, "App created successfully", app_detail_fields)
-    @api.response(403, "Insufficient permissions")
-    @api.response(400, "Invalid request parameters")
+    @console_ns.response(201, "App created successfully", app_detail_fields)
+    @console_ns.response(403, "Insufficient permissions")
+    @console_ns.response(400, "Invalid request parameters")
    @setup_required
    @login_required
    @account_initialization_required
@@ -188,10 +188,10 @@ class AppListApi(Resource):

@console_ns.route("/apps/<uuid:app_id>")
 class AppApi(Resource):
-    @api.doc("get_app_detail")
-    @api.doc(description="Get application details")
-    @api.doc(params={"app_id": "Application ID"})
-    @api.response(200, "Success", app_detail_fields_with_site)
+    @console_ns.doc("get_app_detail")
+    @console_ns.doc(description="Get application details")
+    @console_ns.doc(params={"app_id": "Application ID"})
+    @console_ns.response(200, "Success", app_detail_fields_with_site)
    @setup_required
    @login_required
    @account_initialization_required
@@ -210,11 +210,11 @@ class AppApi(Resource):

        return app_model

-    @api.doc("update_app")
-    @api.doc(description="Update application details")
-    @api.doc(params={"app_id": "Application ID"})
-    @api.expect(
-        api.model(
+    @console_ns.doc("update_app")
+    @console_ns.doc(description="Update application details")
+    @console_ns.doc(params={"app_id": "Application ID"})
+    @console_ns.expect(
+        console_ns.model(
            "UpdateAppRequest",
            {
                "name": fields.String(required=True, description="App name"),
@@ -227,9 +227,9 @@ class AppApi(Resource):
            },
        )
    )
-    @api.response(200, "App updated successfully", app_detail_fields_with_site)
-    @api.response(403, "Insufficient permissions")
-    @api.response(400, "Invalid request parameters")
+    @console_ns.response(200, "App updated successfully", app_detail_fields_with_site)
+    @console_ns.response(403, "Insufficient permissions")
+    @console_ns.response(400, "Invalid request parameters")
    @setup_required
    @login_required
    @account_initialization_required
@@ -265,11 +265,11 @@ class AppApi(Resource):

        return app_model

-    @api.doc("delete_app")
-    @api.doc(description="Delete application")
-    @api.doc(params={"app_id": "Application ID"})
-    @api.response(204, "App deleted successfully")
-    @api.response(403, "Insufficient permissions")
+    @console_ns.doc("delete_app")
+    @console_ns.doc(description="Delete application")
+    @console_ns.doc(params={"app_id": "Application ID"})
+    @console_ns.response(204, "App deleted successfully")
+    @console_ns.response(403, "Insufficient permissions")
    @get_app_model
    @setup_required
    @login_required
@@ -285,11 +285,11 @@ class AppApi(Resource):

@console_ns.route("/apps/<uuid:app_id>/copy")
 class AppCopyApi(Resource):
-    @api.doc("copy_app")
-    @api.doc(description="Create a copy of an existing application")
-    @api.doc(params={"app_id": "Application ID to copy"})
-    @api.expect(
-        api.model(
+    @console_ns.doc("copy_app")
+    @console_ns.doc(description="Create a copy of an existing application")
+    @console_ns.doc(params={"app_id": "Application ID to copy"})
+    @console_ns.expect(
+        console_ns.model(
            "CopyAppRequest",
            {
                "name": fields.String(description="Name for the copied app"),
@@ -300,8 +300,8 @@ class AppCopyApi(Resource):
            },
        )
    )
-    @api.response(201, "App copied successfully", app_detail_fields_with_site)
-    @api.response(403, "Insufficient permissions")
+    @console_ns.response(201, "App copied successfully", app_detail_fields_with_site)
+    @console_ns.response(403, "Insufficient permissions")
    @setup_required
    @login_required
    @account_initialization_required
@@ -346,20 +346,20 @@ class AppCopyApi(Resource):

@console_ns.route("/apps/<uuid:app_id>/export")
 class AppExportApi(Resource):
-    @api.doc("export_app")
-    @api.doc(description="Export application configuration as DSL")
-    @api.doc(params={"app_id": "Application ID to export"})
-    @api.expect(
-        api.parser()
+    @console_ns.doc("export_app")
+    @console_ns.doc(description="Export application configuration as DSL")
+    @console_ns.doc(params={"app_id": "Application ID to export"})
+    @console_ns.expect(
+        console_ns.parser()
        .add_argument("include_secret", type=bool, location="args", default=False, help="Include secrets in export")
        .add_argument("workflow_id", type=str, location="args", help="Specific workflow ID to export")
    )
-    @api.response(
+    @console_ns.response(
        200,
        "App exported successfully",
-        api.model("AppExportResponse", {"data": fields.String(description="DSL export data")}),
+        console_ns.model("AppExportResponse", {"data": fields.String(description="DSL export data")}),
    )
-    @api.response(403, "Insufficient permissions")
+    @console_ns.response(403, "Insufficient permissions")
    @get_app_model
    @setup_required
    @login_required
@@ -387,11 +387,11 @@ parser = reqparse.RequestParser().add_argument("name", type=str, required=True,

@console_ns.route("/apps/<uuid:app_id>/name")
 class AppNameApi(Resource):
-    @api.doc("check_app_name")
-    @api.doc(description="Check if app name is available")
-    @api.doc(params={"app_id": "Application ID"})
-    @api.expect(parser)
-    @api.response(200, "Name availability checked")
+    @console_ns.doc("check_app_name")
+    @console_ns.doc(description="Check if app name is available")
+    @console_ns.doc(params={"app_id": "Application ID"})
+    @console_ns.expect(parser)
+    @console_ns.response(200, "Name availability checked")
    @setup_required
    @login_required
    @account_initialization_required
@@ -409,11 +409,11 @@ class AppNameApi(Resource):

@console_ns.route("/apps/<uuid:app_id>/icon")
 class AppIconApi(Resource):
-    @api.doc("update_app_icon")
-    @api.doc(description="Update application icon")
-    @api.doc(params={"app_id": "Application ID"})
-    @api.expect(
-        api.model(
+    @console_ns.doc("update_app_icon")
+    @console_ns.doc(description="Update application icon")
+    @console_ns.doc(params={"app_id": "Application ID"})
+    @console_ns.expect(
+        console_ns.model(
            "AppIconRequest",
            {
                "icon": fields.String(required=True, description="Icon data"),
@@ -422,8 +422,8 @@ class AppIconApi(Resource):
            },
        )
    )
-    @api.response(200, "Icon updated successfully")
-    @api.response(403, "Insufficient permissions")
+    @console_ns.response(200, "Icon updated successfully")
+    @console_ns.response(403, "Insufficient permissions")
    @setup_required
    @login_required
    @account_initialization_required
@@ -446,16 +446,16 @@ class AppIconApi(Resource):

@console_ns.route("/apps/<uuid:app_id>/site-enable")
 class AppSiteStatus(Resource):
-    @api.doc("update_app_site_status")
-    @api.doc(description="Enable or disable app site")
-    @api.doc(params={"app_id": "Application ID"})
-    @api.expect(
-        api.model(
+    @console_ns.doc("update_app_site_status")
+    @console_ns.doc(description="Enable or disable app site")
+    @console_ns.doc(params={"app_id": "Application ID"})
+    @console_ns.expect(
+        console_ns.model(
            "AppSiteStatusRequest", {"enable_site": fields.Boolean(required=True, description="Enable or disable site")}
        )
    )
-    @api.response(200, "Site status updated successfully", app_detail_fields)
-    @api.response(403, "Insufficient permissions")
+    @console_ns.response(200, "Site status updated successfully", app_detail_fields)
+    @console_ns.response(403, "Insufficient permissions")
    @setup_required
    @login_required
    @account_initialization_required
@@ -474,16 +474,16 @@ class AppSiteStatus(Resource):

@console_ns.route("/apps/<uuid:app_id>/api-enable")
 class AppApiStatus(Resource):
-    @api.doc("update_app_api_status")
-    @api.doc(description="Enable or disable app API")
-    @api.doc(params={"app_id": "Application ID"})
-    @api.expect(
-        api.model(
+    @console_ns.doc("update_app_api_status")
+    @console_ns.doc(description="Enable or disable app API")
+    @console_ns.doc(params={"app_id": "Application ID"})
+    @console_ns.expect(
+        console_ns.model(
            "AppApiStatusRequest", {"enable_api": fields.Boolean(required=True, description="Enable or disable API")}
        )
    )
-    @api.response(200, "API status updated successfully", app_detail_fields)
-    @api.response(403, "Insufficient permissions")
+    @console_ns.response(200, "API status updated successfully", app_detail_fields)
+    @console_ns.response(403, "Insufficient permissions")
    @setup_required
    @login_required
    @is_admin_or_owner_required
@@ -502,10 +502,10 @@ class AppApiStatus(Resource):

@console_ns.route("/apps/<uuid:app_id>/trace")
 class AppTraceApi(Resource):
-    @api.doc("get_app_trace")
-    @api.doc(description="Get app tracing configuration")
-    @api.doc(params={"app_id": "Application ID"})
-    @api.response(200, "Trace configuration retrieved successfully")
+    @console_ns.doc("get_app_trace")
+    @console_ns.doc(description="Get app tracing configuration")
+    @console_ns.doc(params={"app_id": "Application ID"})
+    @console_ns.response(200, "Trace configuration retrieved successfully")
    @setup_required
    @login_required
    @account_initialization_required
@@ -515,11 +515,11 @@ class AppTraceApi(Resource):

        return app_trace_config

-    @api.doc("update_app_trace")
-    @api.doc(description="Update app tracing configuration")
-    @api.doc(params={"app_id": "Application ID"})
-    @api.expect(
-        api.model(
+    @console_ns.doc("update_app_trace")
+    @console_ns.doc(description="Update app tracing configuration")
+    @console_ns.doc(params={"app_id": "Application ID"})
+    @console_ns.expect(
+        console_ns.model(
            "AppTraceRequest",
            {
                "enabled": fields.Boolean(required=True, description="Enable or disable tracing"),
@@ -527,8 +527,8 @@ class AppTraceApi(Resource):
            },
        )
    )
-    @api.response(200, "Trace configuration updated successfully")
-    @api.response(403, "Insufficient permissions")
+    @console_ns.response(200, "Trace configuration updated successfully")
+    @console_ns.response(403, "Insufficient permissions")
    @setup_required
    @login_required
    @account_initialization_required