@nocobase/plugin-workflow 2.1.0-alpha.1 → 2.1.0-alpha.11

package/dist/swagger/index.d.ts

@@ -6,20 +6,85 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
+/**
+ * NocoBase Workflow Plugin — Swagger / OpenAPI 3.0 document
+ *
+ * Resources covered:
+ *   workflows         — Workflow CRUD, versioning, sync and manual execution
+ *   workflows.nodes   — Create nodes inside a workflow (association resource)
+ *   flow_nodes        — Update / delete / move / duplicate / test nodes
+ *   executions        — Execution record queries, cancellation and deletion
+ *   jobs              — Node job queries and resuming paused executions
+ *   userWorkflowTasks — Current-user's pending workflow tasks
+ *
+ * API conventions:
+ *   Base URL  : /api
+ *   Route fmt : /api/<resource>:<action>
+ *   Assoc fmt : /api/<resource>/<sourceId>/<association>:<action>
+ *
+ * Client-side usage (example):
+ *   import { useAPIClient } from '@nocobase/client';
+ *   const api = useAPIClient();
+ *   await api.resource('workflows').list({ filter: { current: true } });
+ *
+ * Direct HTTP usage (example):
+ *   GET /api/workflows:list?filter={"current":true}&sort=-createdAt&except[]=config
+ *   Headers: Authorization: Bearer <token>
+ */
 declare const _default: {
     openapi: string;
     info: {
         title: string;
     };
-    tags: any[];
+    tags: {
+        name: string;
+        description: string;
+    }[];
     paths: {
         '/workflows:list': {
             get: {
                 tags: string[];
+                summary: string;
                 description: string;
-                parameters: {
+                parameters: ({
                     $ref: string;
-                }[];
+                    name?: undefined;
+                    in?: undefined;
+                    description?: undefined;
+                    schema?: undefined;
+                } | {
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                        items?: undefined;
+                        default?: undefined;
+                    };
+                    $ref?: undefined;
+                } | {
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                        default?: undefined;
+                    };
+                    $ref?: undefined;
+                } | {
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                        default: number;
+                        items?: undefined;
+                    };
+                    $ref?: undefined;
+                })[];
                 responses: {
                     200: {
                         description: string;
@@ -40,10 +105,26 @@ declare const _default: {
         '/workflows:get': {
             get: {
                 tags: string[];
+                summary: string;
                 description: string;
-                parameters: {
+                parameters: ({
                     $ref: string;
-                }[];
+                    name?: undefined;
+                    in?: undefined;
+                    description?: undefined;
+                    schema?: undefined;
+                } | {
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    $ref?: undefined;
+                })[];
                 responses: {
                     200: {
                         description: string;
@@ -76,6 +157,7 @@ declare const _default: {
         '/workflows:create': {
             post: {
                 tags: string[];
+                summary: string;
                 description: string;
                 parameters: any[];
                 requestBody: {
@@ -83,6 +165,7 @@ declare const _default: {
                         'application/json': {
                             schema: {
                                 type: string;
+                                required: string[];
                                 properties: {
                                     title: {
                                         $ref: string;
@@ -93,6 +176,24 @@ declare const _default: {
                                     description: {
                                         $ref: string;
                                     };
+                                    enabled: {
+                                        $ref: string;
+                                    };
+                                    sync: {
+                                        $ref: string;
+                                    };
+                                    triggerTitle: {
+                                        $ref: string;
+                                    };
+                                    config: {
+                                        $ref: string;
+                                    };
+                                    options: {
+                                        $ref: string;
+                                    };
+                                    categories: {
+                                        $ref: string;
+                                    };
                                 };
                             };
                         };
@@ -104,9 +205,7 @@ declare const _default: {
                         content: {
                             'application/json': {
                                 schema: {
-                                    allOf: {
-                                        $ref: string;
-                                    }[];
+                                    $ref: string;
                                 };
                             };
                         };
@@ -117,8 +216,11 @@ declare const _default: {
         '/workflows:update': {
             post: {
                 tags: string[];
+                summary: string;
                 description: string;
-                parameters: any[];
+                parameters: {
+                    $ref: string;
+                }[];
                 requestBody: {
                     content: {
                         'application/json': {
@@ -134,9 +236,18 @@ declare const _default: {
                                     description: {
                                         $ref: string;
                                     };
+                                    triggerTitle: {
+                                        $ref: string;
+                                    };
                                     config: {
                                         $ref: string;
                                     };
+                                    options: {
+                                        $ref: string;
+                                    };
+                                    categories: {
+                                        $ref: string;
+                                    };
                                 };
                             };
                         };
@@ -146,12 +257,16 @@ declare const _default: {
                     200: {
                         description: string;
                     };
+                    400: {
+                        description: string;
+                    };
                 };
             };
         };
         '/workflows:destroy': {
             post: {
                 tags: string[];
+                summary: string;
                 description: string;
                 parameters: ({
                     name: string;
@@ -159,7 +274,6 @@ declare const _default: {
                     description: string;
                     schema: {
                         type: string;
-                        description: string;
                         properties?: undefined;
                     };
                 } | {
@@ -174,7 +288,6 @@ declare const _default: {
                                 description: string;
                             };
                         };
-                        description?: undefined;
                     };
                 })[];
                 responses: {
@@ -187,6 +300,7 @@ declare const _default: {
         '/workflows:revision': {
             post: {
                 tags: string[];
+                summary: string;
                 description: string;
                 parameters: ({
                     name: string;
@@ -194,7 +308,6 @@ declare const _default: {
                     description: string;
                     schema: {
                         type: string;
-                        description: string;
                         properties?: undefined;
                     };
                 } | {
@@ -209,19 +322,55 @@ declare const _default: {
                                 description: string;
                             };
                         };
-                        description?: undefined;
                     };
                 })[];
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: string;
+                                properties: {
+                                    values: {
+                                        type: string;
+                                        description: string;
+                                        properties: {
+                                            title: {
+                                                type: string;
+                                                description: string;
+                                            };
+                                            enabled: {
+                                                type: string;
+                                                description: string;
+                                            };
+                                            current: {
+                                                type: string;
+                                                description: string;
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
                 responses: {
                     200: {
                         description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
                     };
                 };
             };
         };
-        '/workflows:trigger': {
+        '/workflows:sync': {
             post: {
                 tags: string[];
+                summary: string;
                 description: string;
                 parameters: {
                     name: string;
@@ -232,30 +381,121 @@ declare const _default: {
                     };
                 }[];
                 responses: {
-                    202: {
+                    204: {
                         description: string;
                     };
+                };
+            };
+        };
+        '/workflows:execute': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                        enum?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                        enum: number[];
+                    };
+                    required?: undefined;
+                })[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: string;
+                                required: string[];
+                                properties: {
+                                    values: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        execution: {
+                                            type: string;
+                                            properties: {
+                                                id: {
+                                                    type: string;
+                                                    description: string;
+                                                };
+                                                status: {
+                                                    type: string;
+                                                    description: string;
+                                                };
+                                            };
+                                        };
+                                        newVersionId: {
+                                            type: string;
+                                            nullable: boolean;
+                                            description: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
                     400: {
                         description: string;
                     };
+                    404: {
+                        description: string;
+                    };
                 };
             };
         };
         '/workflows/{workflowId}/nodes:create': {
             post: {
                 tags: string[];
+                summary: string;
                 description: string;
-                parameters: any[];
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                    };
+                }[];
                 requestBody: {
                     content: {
                         'application/json': {
                             schema: {
                                 type: string;
+                                required: string[];
                                 properties: {
+                                    type: {
+                                        $ref: string;
+                                    };
                                     title: {
                                         $ref: string;
                                     };
-                                    type: {
+                                    config: {
                                         $ref: string;
                                     };
                                     upstreamId: {
@@ -282,20 +522,64 @@ declare const _default: {
                             };
                         };
                     };
+                    400: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/flow_nodes:get': {
+            get: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                        items?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    required?: undefined;
+                })[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
                 };
             };
         };
         '/flow_nodes:update': {
             post: {
                 tags: string[];
+                summary: string;
                 description: string;
                 parameters: {
                     name: string;
                     in: string;
+                    required: boolean;
                     description: string;
                     schema: {
                         type: string;
-                        description: string;
                     };
                 }[];
                 requestBody: {
@@ -310,6 +594,244 @@ declare const _default: {
                                     config: {
                                         $ref: string;
                                     };
+                                    branchIndex: {
+                                        $ref: string;
+                                    };
+                                    updateAssociationValues: {
+                                        type: string;
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/flow_nodes:destroy': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                    };
+                    required?: undefined;
+                })[];
+                responses: {
+                    200: {
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/flow_nodes:destroyBranch': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                        enum?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                        enum: number[];
+                    };
+                    required?: undefined;
+                })[];
+                responses: {
+                    200: {
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/flow_nodes:duplicate': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: string;
+                                properties: {
+                                    values: {
+                                        type: string;
+                                        description: string;
+                                        properties: {
+                                            upstreamId: {
+                                                $ref: string;
+                                            };
+                                            branchIndex: {
+                                                $ref: string;
+                                            };
+                                            config: {
+                                                $ref: string;
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    400: {
+                        description: string;
+                    };
+                    404: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/flow_nodes:move': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: string;
+                                properties: {
+                                    values: {
+                                        type: string;
+                                        description: string;
+                                        properties: {
+                                            upstreamId: {
+                                                type: string;
+                                                nullable: boolean;
+                                                description: string;
+                                            };
+                                            branchIndex: {
+                                                type: string;
+                                                nullable: boolean;
+                                                description: string;
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    400: {
+                        description: string;
+                    };
+                    404: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/flow_nodes:test': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: any[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: string;
+                                required: string[];
+                                properties: {
+                                    values: {
+                                        type: string;
+                                        required: string[];
+                                        properties: {
+                                            type: {
+                                                $ref: string;
+                                            };
+                                            config: {
+                                                $ref: string;
+                                            };
+                                        };
+                                    };
                                 };
                             };
                         };
@@ -318,41 +840,58 @@ declare const _default: {
                 responses: {
                     200: {
                         description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
                     };
                     400: {
                         description: string;
                     };
+                    500: {
+                        description: string;
+                    };
                 };
             };
         };
-        '/flow_nodes:destroy': {
-            post: {
+        '/executions:list': {
+            get: {
                 tags: string[];
+                summary: string;
                 description: string;
-                parameters: {
+                parameters: ({
                     name: string;
                     in: string;
                     description: string;
                     schema: {
                         type: string;
-                        description: string;
+                        items?: undefined;
+                        default?: undefined;
                     };
-                }[];
-                responses: {
-                    200: {
-                        description: string;
+                } | {
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                        default?: undefined;
                     };
-                    400: {
-                        description: string;
+                } | {
+                    name: string;
+                    in: string;
+                    schema: {
+                        type: string;
+                        default: number;
+                        items?: undefined;
                     };
-                };
-            };
-        };
-        '/executions:list': {
-            get: {
-                tags: string[];
-                description: string;
-                parameters: any[];
+                    description?: undefined;
+                })[];
                 responses: {
                     200: {
                         description: string;
@@ -378,14 +917,55 @@ declare const _default: {
         '/executions:get': {
             get: {
                 tags: string[];
+                summary: string;
                 description: string;
-                parameters: {
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                        items?: undefined;
+                    };
+                } | {
                     name: string;
                     in: string;
                     description: string;
                     schema: {
                         type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    required?: undefined;
+                })[];
+                responses: {
+                    200: {
                         description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/executions:cancel': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
                     };
                 }[];
                 responses: {
@@ -399,14 +979,67 @@ declare const _default: {
                             };
                         };
                     };
+                    400: {
+                        description: string;
+                    };
+                    404: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/executions:destroy': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                    };
                 };
             };
         };
-        '/workflowManualTasks:list': {
+        '/jobs:list': {
             get: {
                 tags: string[];
+                summary: string;
                 description: string;
-                parameters: any[];
+                parameters: ({
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                        items?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    schema: {
+                        type: string;
+                        items?: undefined;
+                    };
+                    description?: undefined;
+                })[];
                 responses: {
                     200: {
                         description: string;
@@ -414,7 +1047,6 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     type: string;
-                                    description: string;
                                     items: {
                                         $ref: string;
                                     };
@@ -425,30 +1057,39 @@ declare const _default: {
                 };
             };
         };
-        '/workflowManualTasks:get': {
+        '/jobs:get': {
             get: {
                 tags: string[];
+                summary: string;
                 description: string;
-                parameters: any[];
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                        items?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    required?: undefined;
+                })[];
                 responses: {
                     200: {
                         description: string;
                         content: {
                             'application/json': {
                                 schema: {
-                                    allOf: ({
-                                        $ref: string;
-                                        type?: undefined;
-                                        properties?: undefined;
-                                    } | {
-                                        type: string;
-                                        properties: {
-                                            execution: {
-                                                $ref: string;
-                                            };
-                                        };
-                                        $ref?: undefined;
-                                    })[];
+                                    $ref: string;
                                 };
                             };
                         };
@@ -456,17 +1097,18 @@ declare const _default: {
                 };
             };
         };
-        '/workflowManualTasks:submit': {
+        '/jobs:resume': {
             post: {
                 tags: string[];
+                summary: string;
                 description: string;
                 parameters: {
                     name: string;
                     in: string;
+                    required: boolean;
                     description: string;
                     schema: {
                         type: string;
-                        description: string;
                     };
                 }[];
                 requestBody: {
@@ -475,14 +1117,21 @@ declare const _default: {
                             schema: {
                                 type: string;
                                 properties: {
-                                    result: {
+                                    values: {
                                         type: string;
+                                        description: string;
                                         properties: {
-                                            $formKey: {
+                                            status: {
                                                 type: string;
+                                                description: string;
                                             };
-                                            _: {
+                                            result: {
                                                 type: string;
+                                                description: string;
+                                            };
+                                            meta: {
+                                                type: string;
+                                                description: string;
                                             };
                                         };
                                     };
@@ -494,9 +1143,65 @@ declare const _default: {
                 responses: {
                     202: {
                         description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    404: {
+                        description: string;
                     };
-                    400: {
+                };
+            };
+        };
+        '/userWorkflowTasks:listMine': {
+            get: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                        items?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    description: string;
+                    schema: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    schema: {
+                        type: string;
+                        items?: undefined;
+                    };
+                    description?: undefined;
+                })[];
+                responses: {
+                    200: {
                         description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    items: {
+                                        $ref: string;
+                                    };
+                                };
+                            };
+                        };
                     };
                 };
             };
@@ -525,6 +1230,10 @@ declare const _default: {
                             type: string;
                             description: string;
                         };
+                        triggerTitle: {
+                            type: string;
+                            description: string;
+                        };
                         current: {
                             type: string;
                             description: string;
@@ -537,10 +1246,39 @@ declare const _default: {
                             type: string;
                             description: string;
                         };
+                        sync: {
+                            type: string;
+                            description: string;
+                        };
                         config: {
                             type: string;
                             description: string;
                         };
+                        options: {
+                            type: string;
+                            description: string;
+                            properties: {
+                                deleteExecutionOnStatus: {
+                                    type: string;
+                                    description: string;
+                                    items: {
+                                        type: string;
+                                    };
+                                };
+                                stackLimit: {
+                                    type: string;
+                                    description: string;
+                                    default: number;
+                                };
+                            };
+                        };
+                        categories: {
+                            type: string;
+                            description: string;
+                            items: {
+                                type: string;
+                            };
+                        };
                         nodes: {
                             type: string;
                             description: string;
@@ -611,6 +1349,7 @@ declare const _default: {
                     };
                     upstreamId: {
                         type: string;
+                        nullable: boolean;
                         description: string;
                     };
                     upstream: {
@@ -620,8 +1359,8 @@ declare const _default: {
                     };
                     downstreamId: {
                         type: string;
+                        nullable: boolean;
                         description: string;
-                        $ref: string;
                     };
                     downstream: {
                         type: string;
@@ -638,6 +1377,7 @@ declare const _default: {
                     };
                     branchIndex: {
                         type: string;
+                        nullable: boolean;
                         description: string;
                     };
                     branches: {
@@ -673,6 +1413,10 @@ declare const _default: {
                         type: string;
                         description: string;
                     };
+                    output: {
+                        type: string;
+                        description: string;
+                    };
                     jobs: {
                         type: string;
                         description: string;
@@ -698,6 +1442,10 @@ declare const _default: {
                         type: string;
                         description: string;
                     };
+                    nodeKey: {
+                        type: string;
+                        description: string;
+                    };
                     status: {
                         type: string;
                         description: string;
@@ -706,6 +1454,10 @@ declare const _default: {
                         type: string;
                         description: string;
                     };
+                    meta: {
+                        type: string;
+                        description: string;
+                    };
                 };
             };
             user_job: {