docs: make swagger

actiontech · Oct 22, 2024 · e19cec9 · e19cec9
1 parent 87b2d35
commit e19cec9
Show file tree

Hide file tree

Showing 3 changed files with 560 additions and 3 deletions.
diff --git a/sqle/docs/docs.go b/sqle/docs/docs.go
@@ -8044,6 +8044,54 @@ var doc = `{
                 }
             }
         },
+        "/v1/sql_manages/statistics": {
+            "get": {
+                "security": [
+                    {
+                        "ApiKeyAuth": []
+                    }
+                ],
+                "description": "get global sql manage statistics",
+                "tags": [
+                    "SqlManage"
+                ],
+                "summary": "获取全局管控sql统计信息",
+                "operationId": "GetGlobalSqlManageStatistics",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "project uid",
+                        "name": "filter_project_uid",
+                        "in": "query"
+                    },
+                    {
+                        "type": "string",
+                        "description": "instance id",
+                        "name": "filter_instance_id",
+                        "in": "query"
+                    },
+                    {
+                        "enum": [
+                            "high",
+                            "medium",
+                            "low"
+                        ],
+                        "type": "string",
+                        "description": "project priority",
+                        "name": "filter_project_priority",
+                        "in": "query"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/v1.GetGlobalSqlManageStatisticsResp"
+                        }
+                    }
+                }
+            }
+        },
         "/v1/statistic/instances/sql_average_execution_time": {
             "get": {
                 "security": [
@@ -8421,6 +8469,29 @@ var doc = `{
                 }
             }
         },
+        "/v1/system/module_red_dots": {
+            "get": {
+                "security": [
+                    {
+                        "ApiKeyAuth": []
+                    }
+                ],
+                "description": "get the red dot prompt information in the system",
+                "tags": [
+                    "system"
+                ],
+                "summary": "查询系统各模块的红点提示信息",
+                "operationId": "GetSystemModuleRedDots",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/v1.GetSystemModuleRedDotsRes"
+                        }
+                    }
+                }
+            }
+        },
         "/v1/system/module_status": {
             "get": {
                 "security": [
@@ -9119,6 +9190,78 @@ var doc = `{
                 }
             }
         },
+        "/v1/workflows/statistics": {
+            "get": {
+                "security": [
+                    {
+                        "ApiKeyAuth": []
+                    }
+                ],
+                "description": "get global workflow statistics",
+                "tags": [
+                    "workflow"
+                ],
+                "summary": "获取全局工单统计数据",
+                "operationId": "GetGlobalWorkflowStatistics",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "filter create user id",
+                        "name": "filter_create_user_id",
+                        "in": "query"
+                    },
+                    {
+                        "enum": [
+                            "wait_for_audit",
+                            "wait_for_execution",
+                            "rejected",
+                            "executing",
+                            "canceled",
+                            "exec_failed",
+                            "finished"
+                        ],
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        },
+                        "description": "filter by workflow status,, support using many status",
+                        "name": "filter_status_list",
+                        "in": "query"
+                    },
+                    {
+                        "type": "string",
+                        "description": "filter by project uid",
+                        "name": "filter_project_uid",
+                        "in": "query"
+                    },
+                    {
+                        "type": "string",
+                        "description": "filter by instance id in project",
+                        "name": "filter_instance_id",
+                        "in": "query"
+                    },
+                    {
+                        "enum": [
+                            "high",
+                            "medium",
+                            "low"
+                        ],
+                        "type": "string",
+                        "description": "filter by project priority",
+                        "name": "filter_project_priority",
+                        "in": "query"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/v1.GlobalWorkflowStatisticsResV1"
+                        }
+                    }
+                }
+            }
+        },
         "/v2/audit_files": {
             "post": {
                 "security": [
@@ -12837,7 +12980,23 @@ var doc = `{
                     "type": "string",
                     "example": "ok"
                 },
-                "total_num": {
+                "total_nums": {
+                    "type": "integer"
+                }
+            }
+        },
+        "v1.GetGlobalSqlManageStatisticsResp": {
+            "type": "object",
+            "properties": {
+                "code": {
+                    "type": "integer",
+                    "example": 0
+                },
+                "message": {
+                    "type": "string",
+                    "example": "ok"
+                },
+                "total_nums": {
                     "type": "integer"
                 }
             }
@@ -13782,6 +13941,23 @@ var doc = `{
                 }
             }
         },
+        "v1.GetSystemModuleRedDotsRes": {
+            "type": "object",
+            "properties": {
+                "code": {
+                    "type": "integer",
+                    "example": 0
+                },
+                "data": {
+                    "type": "object",
+                    "$ref": "#/definitions/v1.ModuleRedDots"
+                },
+                "message": {
+                    "type": "string",
+                    "example": "ok"
+                }
+            }
+        },
         "v1.GetSystemVariablesResV1": {
             "type": "object",
             "properties": {
@@ -14284,6 +14460,22 @@ var doc = `{
                 }
             }
         },
+        "v1.GlobalWorkflowStatisticsResV1": {
+            "type": "object",
+            "properties": {
+                "code": {
+                    "type": "integer",
+                    "example": 0
+                },
+                "message": {
+                    "type": "string",
+                    "example": "ok"
+                },
+                "total_nums": {
+                    "type": "integer"
+                }
+            }
+        },
         "v1.HighPriorityConditionReq": {
             "type": "object",
             "properties": {
@@ -14698,6 +14890,23 @@ var doc = `{
                 }
             }
         },
+        "v1.ModuleRedDot": {
+            "type": "object",
+            "properties": {
+                "has_red_dot": {
+                    "type": "boolean"
+                },
+                "module_name": {
+                    "type": "string"
+                }
+            }
+        },
+        "v1.ModuleRedDots": {
+            "type": "array",
+            "items": {
+                "$ref": "#/definitions/v1.ModuleRedDot"
+            }
+        },
         "v1.ModuleStatusRes": {
             "type": "object",
             "properties": {