chore: update swag docs

actiontech · Jul 12, 2024 · 33eb51b · 33eb51b
1 parent 6328154
commit 33eb51b
Show file tree

Hide file tree

Showing 3 changed files with 95 additions and 95 deletions.
diff --git a/sqle/docs/docs.go b/sqle/docs/docs.go
@@ -7040,19 +7040,19 @@ var doc = `{
                 }
             }
         },
-        "/v1/workflows_info_of_instances": {
+        "/v1/workflows/statistic_of_instances": {
             "get": {
                 "security": [
                     {
                         "ApiKeyAuth": []
                     }
                 ],
-                "description": "Get Unfinished Workflows Count Of Instances",
+                "description": "Get Workflows Statistic Of Instances",
                 "tags": [
                     "workflow"
                 ],
-                "summary": "获取实例上未完成的工单数量",
-                "operationId": "GetUnfinishedWorkflowsCountOfInstances",
+                "summary": "获取实例上工单的统计信息",
+                "operationId": "GetWorkflowStatisticOfInstances",
                 "parameters": [
                     {
                         "type": "string",
@@ -7066,7 +7066,7 @@ var doc = `{
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/v1.GetUnfinishedWorkflowsCountOfInstancesResV1"
+                            "$ref": "#/definitions/v1.GetWorkflowStatisticOfInstancesResV1"
                         }
                     }
                 }
@@ -10870,25 +10870,6 @@ var doc = `{
                 }
             }
         },
-        "v1.GetUnfinishedWorkflowsCountOfInstancesResV1": {
-            "type": "object",
-            "properties": {
-                "code": {
-                    "type": "integer",
-                    "example": 0
-                },
-                "data": {
-                    "type": "array",
-                    "items": {
-                        "$ref": "#/definitions/v1.UnfinishedWorkflowsCountV1"
-                    }
-                },
-                "message": {
-                    "type": "string",
-                    "example": "ok"
-                }
-            }
-        },
         "v1.GetUserTipsResV1": {
             "type": "object",
             "properties": {
@@ -11099,6 +11080,25 @@ var doc = `{
                 }
             }
         },
+        "v1.GetWorkflowStatisticOfInstancesResV1": {
+            "type": "object",
+            "properties": {
+                "code": {
+                    "type": "integer",
+                    "example": 0
+                },
+                "data": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/v1.WorkflowStatisticOfInstance"
+                    }
+                },
+                "message": {
+                    "type": "string",
+                    "example": "ok"
+                }
+            }
+        },
         "v1.GetWorkflowStatusCountResV1": {
             "type": "object",
             "properties": {
@@ -12839,17 +12839,6 @@ var doc = `{
                 }
             }
         },
-        "v1.UnfinishedWorkflowsCountV1": {
-            "type": "object",
-            "properties": {
-                "instance_id": {
-                    "type": "integer"
-                },
-                "unfinished_count": {
-                    "type": "integer"
-                }
-            }
-        },
         "v1.UpdateAuditPlanNotifyConfigReqV1": {
             "type": "object",
             "properties": {
@@ -13457,6 +13446,17 @@ var doc = `{
                 }
             }
         },
+        "v1.WorkflowStatisticOfInstance": {
+            "type": "object",
+            "properties": {
+                "instance_id": {
+                    "type": "integer"
+                },
+                "unfinished_count": {
+                    "type": "integer"
+                }
+            }
+        },
         "v1.WorkflowStatisticsResV1": {
             "type": "object",
             "properties": {

diff --git a/sqle/docs/swagger.json b/sqle/docs/swagger.json
@@ -7024,19 +7024,19 @@
                 }
             }
         },
-        "/v1/workflows_info_of_instances": {
+        "/v1/workflows/statistic_of_instances": {
             "get": {
                 "security": [
                     {
                         "ApiKeyAuth": []
                     }
                 ],
-                "description": "Get Unfinished Workflows Count Of Instances",
+                "description": "Get Workflows Statistic Of Instances",
                 "tags": [
                     "workflow"
                 ],
-                "summary": "获取实例上未完成的工单数量",
-                "operationId": "GetUnfinishedWorkflowsCountOfInstances",
+                "summary": "获取实例上工单的统计信息",
+                "operationId": "GetWorkflowStatisticOfInstances",
                 "parameters": [
                     {
                         "type": "string",
@@ -7050,7 +7050,7 @@
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/v1.GetUnfinishedWorkflowsCountOfInstancesResV1"
+                            "$ref": "#/definitions/v1.GetWorkflowStatisticOfInstancesResV1"
                         }
                     }
                 }
@@ -10854,25 +10854,6 @@
                 }
             }
         },
-        "v1.GetUnfinishedWorkflowsCountOfInstancesResV1": {
-            "type": "object",
-            "properties": {
-                "code": {
-                    "type": "integer",
-                    "example": 0
-                },
-                "data": {
-                    "type": "array",
-                    "items": {
-                        "$ref": "#/definitions/v1.UnfinishedWorkflowsCountV1"
-                    }
-                },
-                "message": {
-                    "type": "string",
-                    "example": "ok"
-                }
-            }
-        },
         "v1.GetUserTipsResV1": {
             "type": "object",
             "properties": {
@@ -11083,6 +11064,25 @@
                 }
             }
         },
+        "v1.GetWorkflowStatisticOfInstancesResV1": {
+            "type": "object",
+            "properties": {
+                "code": {
+                    "type": "integer",
+                    "example": 0
+                },
+                "data": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/v1.WorkflowStatisticOfInstance"
+                    }
+                },
+                "message": {
+                    "type": "string",
+                    "example": "ok"
+                }
+            }
+        },
         "v1.GetWorkflowStatusCountResV1": {
             "type": "object",
             "properties": {
@@ -12823,17 +12823,6 @@
                 }
             }
         },
-        "v1.UnfinishedWorkflowsCountV1": {
-            "type": "object",
-            "properties": {
-                "instance_id": {
-                    "type": "integer"
-                },
-                "unfinished_count": {
-                    "type": "integer"
-                }
-            }
-        },
         "v1.UpdateAuditPlanNotifyConfigReqV1": {
             "type": "object",
             "properties": {
@@ -13441,6 +13430,17 @@
                 }
             }
         },
+        "v1.WorkflowStatisticOfInstance": {
+            "type": "object",
+            "properties": {
+                "instance_id": {
+                    "type": "integer"
+                },
+                "unfinished_count": {
+                    "type": "integer"
+                }
+            }
+        },
         "v1.WorkflowStatisticsResV1": {
             "type": "object",
             "properties": {

diff --git a/sqle/docs/swagger.yaml b/sqle/docs/swagger.yaml
@@ -1700,19 +1700,6 @@ definitions:
         example: ok
         type: string
     type: object
-  v1.GetUnfinishedWorkflowsCountOfInstancesResV1:
-    properties:
-      code:
-        example: 0
-        type: integer
-      data:
-        items:
-          $ref: '#/definitions/v1.UnfinishedWorkflowsCountV1'
-        type: array
-      message:
-        example: ok
-        type: string
-    type: object
   v1.GetUserTipsResV1:
     properties:
       code:
@@ -1860,6 +1847,19 @@ definitions:
         example: ok
         type: string
     type: object
+  v1.GetWorkflowStatisticOfInstancesResV1:
+    properties:
+      code:
+        example: 0
+        type: integer
+      data:
+        items:
+          $ref: '#/definitions/v1.WorkflowStatisticOfInstance'
+        type: array
+      message:
+        example: ok
+        type: string
+    type: object
   v1.GetWorkflowStatusCountResV1:
     properties:
       code:
@@ -3027,13 +3027,6 @@ definitions:
         example: ok
         type: string
     type: object
-  v1.UnfinishedWorkflowsCountV1:
-    properties:
-      instance_id:
-        type: integer
-      unfinished_count:
-        type: integer
-    type: object
   v1.UpdateAuditPlanNotifyConfigReqV1:
     properties:
       enable_email_notify:
@@ -3443,6 +3436,13 @@ definitions:
       minutes:
         type: integer
     type: object
+  v1.WorkflowStatisticOfInstance:
+    properties:
+      instance_id:
+        type: integer
+      unfinished_count:
+        type: integer
+    type: object
   v1.WorkflowStatisticsResV1:
     properties:
       my_need_execute_workflow_number:
@@ -8881,10 +8881,10 @@ paths:
       summary: 获取全局工单列表
       tags:
       - workflow
-  /v1/workflows_info_of_instances:
+  /v1/workflows/statistic_of_instances:
     get:
-      description: Get Unfinished Workflows Count Of Instances
-      operationId: GetUnfinishedWorkflowsCountOfInstances
+      description: Get Workflows Statistic Of Instances
+      operationId: GetWorkflowStatisticOfInstances
       parameters:
       - description: instance id
         in: query
@@ -8895,10 +8895,10 @@ paths:
         "200":
           description: OK
           schema:
-            $ref: '#/definitions/v1.GetUnfinishedWorkflowsCountOfInstancesResV1'
+            $ref: '#/definitions/v1.GetWorkflowStatisticOfInstancesResV1'
       security:
       - ApiKeyAuth: []
-      summary: 获取实例上未完成的工单数量
+      summary: 获取实例上工单的统计信息
       tags:
       - workflow
   /v2/audit_files: