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

package/dist/swagger/index.d.ts

@@ -0,0 +1,892 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+declare const _default: {
+    openapi: string;
+    info: {
+        title: string;
+        version: string;
+    };
+    paths: {
+        '/roles/{roleName}/desktopRoutes:add': {
+            post: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/roles/{roleName}/desktopRoutes:remove': {
+            post: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/roles/{roleName}/desktopRoutes:set': {
+            post: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/roles/{roleName}/desktopRoutes:list': {
+            get: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        data: {
+                                            type: string;
+                                            items: {
+                                                $ref: string;
+                                            };
+                                        };
+                                        meta: {
+                                            type: string;
+                                            additionalProperties: boolean;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/desktopRoutes:listAccessible': {
+            get: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/desktopRoutes:getAccessible': {
+            get: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/desktopRoutes:create': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/desktopRoutes:update': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/desktopRoutes:updateOrCreate': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/desktopRoutes:move': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/desktopRoutes:destroy': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/desktopRoutes:createV2': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                            examples: {
+                                createV2: {
+                                    summary: string;
+                                    value: {
+                                        schemaUid: string;
+                                        parentId: any;
+                                        title: string;
+                                        icon: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    400: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    409: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/desktopRoutes:destroyV2': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                            examples: {
+                                destroyV2: {
+                                    summary: string;
+                                    value: {
+                                        schemaUid: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                    400: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+    components: {
+        parameters: {
+            RoleNamePath: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                };
+            };
+            PaginateQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                };
+            };
+            TreeQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                };
+            };
+            SortScalarQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                };
+            };
+            FilterQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: string;
+                            additionalProperties: boolean;
+                        };
+                    };
+                };
+            };
+            FilterByTkQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                };
+            };
+            FilterKeysQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+            };
+            SourceIdQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                };
+            };
+            TargetIdQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                };
+            };
+            MethodQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                };
+            };
+            SortFieldQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                };
+            };
+            TargetScopeQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: string;
+                            additionalProperties: boolean;
+                        };
+                    };
+                };
+            };
+            StickyQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                };
+            };
+        };
+        schemas: {
+            RouteIdList: {
+                type: string;
+                description: string;
+                items: {
+                    type: string;
+                };
+            };
+            ErrorItem: {
+                type: string;
+                required: string[];
+                properties: {
+                    code: {
+                        type: string;
+                    };
+                    message: {
+                        type: string;
+                    };
+                    details: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                    opId: {
+                        type: string;
+                    };
+                    opIndex: {
+                        type: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            ErrorResponse: {
+                type: string;
+                required: string[];
+                properties: {
+                    errors: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DataWrappedDesktopRouteListResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DataWrappedNullableDesktopRouteResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        anyOf: ({
+                            $ref: string;
+                            type?: undefined;
+                        } | {
+                            type: string;
+                            $ref?: undefined;
+                        })[];
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DataWrappedDesktopRouteResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        $ref: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DataWrappedDesktopRouteOrListResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        anyOf: ({
+                            $ref: string;
+                            type?: undefined;
+                            items?: undefined;
+                        } | {
+                            type: string;
+                            items: {
+                                $ref: string;
+                            };
+                            $ref?: undefined;
+                        })[];
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DataWrappedDesktopRouteCreateV2Response: {
+                type: string;
+                properties: {
+                    data: {
+                        $ref: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DataWrappedOkResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        $ref: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DesktopRoute: {
+                type: string;
+                properties: {
+                    id: {
+                        oneOf: {
+                            type: string;
+                        }[];
+                    };
+                    title: {
+                        type: string;
+                    };
+                    tooltip: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    type: {
+                        type: string;
+                    };
+                    icon: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    path: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    parentId: {
+                        anyOf: {
+                            type: string;
+                        }[];
+                    };
+                    schemaUid: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    menuSchemaUid: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    tabSchemaName: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    hideInMenu: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    enableTabs: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    enableHeader: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    displayTitle: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    hidden: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    sort: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    options: {
+                        type: string;
+                        additionalProperties: boolean;
+                        nullable: boolean;
+                    };
+                    children: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DesktopRouteCreateValues: {
+                type: string;
+                properties: {
+                    type: {
+                        type: string;
+                    };
+                    title: {
+                        type: string;
+                    };
+                    tooltip: {
+                        type: string;
+                    };
+                    icon: {
+                        type: string;
+                    };
+                    parentId: {
+                        anyOf: {
+                            type: string;
+                        }[];
+                    };
+                    schemaUid: {
+                        type: string;
+                    };
+                    menuSchemaUid: {
+                        type: string;
+                    };
+                    tabSchemaName: {
+                        type: string;
+                    };
+                    hideInMenu: {
+                        type: string;
+                    };
+                    enableTabs: {
+                        type: string;
+                    };
+                    enableHeader: {
+                        type: string;
+                    };
+                    displayTitle: {
+                        type: string;
+                    };
+                    hidden: {
+                        type: string;
+                    };
+                    sort: {
+                        type: string;
+                    };
+                    options: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                    children: {
+                        type: string;
+                        items: {
+                            type: string;
+                            additionalProperties: boolean;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DesktopRouteUpdateValues: {
+                type: string;
+                additionalProperties: boolean;
+            };
+            DesktopRouteCreateV2Request: {
+                type: string;
+                required: string[];
+                properties: {
+                    schemaUid: {
+                        type: string;
+                    };
+                    parentId: {
+                        anyOf: {
+                            type: string;
+                        }[];
+                    };
+                    title: {
+                        type: string;
+                    };
+                    icon: {
+                        type: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DesktopRouteCreateV2Response: {
+                type: string;
+                required: string[];
+                properties: {
+                    page: {
+                        type: string;
+                        properties: {
+                            id: {
+                                oneOf: {
+                                    type: string;
+                                }[];
+                            };
+                            schemaUid: {
+                                type: string;
+                            };
+                            title: {
+                                type: string;
+                            };
+                            icon: {
+                                type: string;
+                                nullable: boolean;
+                            };
+                            parentId: {
+                                anyOf: {
+                                    type: string;
+                                }[];
+                            };
+                            menuSchemaUid: {
+                                type: string;
+                                nullable: boolean;
+                            };
+                        };
+                        additionalProperties: boolean;
+                    };
+                    defaultTab: {
+                        type: string;
+                        nullable: boolean;
+                        properties: {
+                            id: {
+                                oneOf: {
+                                    type: string;
+                                }[];
+                            };
+                            schemaUid: {
+                                type: string;
+                            };
+                            tabSchemaName: {
+                                type: string;
+                                nullable: boolean;
+                            };
+                        };
+                        additionalProperties: boolean;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            DesktopRouteDestroyV2Request: {
+                type: string;
+                required: string[];
+                properties: {
+                    schemaUid: {
+                        type: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            OkResponse: {
+                type: string;
+                required: string[];
+                properties: {
+                    ok: {
+                        type: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+        };
+    };
+};
+export default _default;