@nocobase/plugin-acl 2.1.0-alpha.2 → 2.1.0-alpha.21

package/dist/swagger/index.d.ts

@@ -10,13 +10,13 @@ declare const _default: {
     openapi: string;
     info: {
         title: string;
+        version: string;
     };
     paths: {
         '/roles:list': {
             get: {
                 tags: string[];
-                description: string;
-                parameters: any[];
+                summary: string;
                 responses: {
                     200: {
                         description: string;
@@ -37,15 +37,9 @@ declare const _default: {
         '/roles:get': {
             get: {
                 tags: string[];
-                description: string;
+                summary: string;
                 parameters: {
-                    name: string;
-                    in: string;
-                    description: string;
-                    required: boolean;
-                    schema: {
-                        type: string;
-                    };
+                    $ref: string;
                 }[];
                 responses: {
                     200: {
@@ -64,8 +58,10 @@ declare const _default: {
         '/roles:create': {
             post: {
                 tags: string[];
+                summary: string;
                 description: string;
                 requestBody: {
+                    required: boolean;
                     content: {
                         'application/json': {
                             schema: {
@@ -75,7 +71,7 @@ declare const _default: {
                     };
                 };
                 responses: {
-                    '200': {
+                    200: {
                         description: string;
                         content: {
                             'application/json': {
@@ -91,17 +87,13 @@ declare const _default: {
         '/roles:update': {
             post: {
                 tags: string[];
+                summary: string;
                 description: string;
                 parameters: {
-                    name: string;
-                    in: string;
-                    description: string;
-                    required: boolean;
-                    schema: {
-                        type: string;
-                    };
+                    $ref: string;
                 }[];
                 requestBody: {
+                    required: boolean;
                     content: {
                         'application/json': {
                             schema: {
@@ -127,18 +119,12 @@ declare const _default: {
         '/roles:destroy': {
             post: {
                 tags: string[];
-                description: string;
+                summary: string;
                 parameters: {
-                    name: string;
-                    in: string;
-                    description: string;
-                    required: boolean;
-                    schema: {
-                        type: string;
-                    };
+                    $ref: string;
                 }[];
                 responses: {
-                    '200': {
+                    200: {
                         description: string;
                     };
                 };
@@ -147,6 +133,7 @@ declare const _default: {
         '/roles:check': {
             get: {
                 tags: string[];
+                summary: string;
                 description: string;
                 responses: {
                     200: {
@@ -165,8 +152,9 @@ declare const _default: {
         '/roles:setDefaultRole': {
             post: {
                 tags: string[];
-                description: string;
+                summary: string;
                 requestBody: {
+                    required: boolean;
                     content: {
                         'application/json': {
                             schema: {
@@ -176,70 +164,67 @@ declare const _default: {
                                         type: string;
                                     };
                                 };
+                                required: string[];
                             };
                         };
                     };
                 };
                 responses: {
-                    '200': {
+                    200: {
                         description: string;
                     };
                 };
             };
         };
-        '/roles/{roleName}/collections:list': {
-            get: {
+        '/roles:setSystemRoleMode': {
+            post: {
                 tags: string[];
+                summary: string;
                 description: string;
-                parameters: {
-                    name: string;
-                    in: string;
-                    description: string;
+                requestBody: {
                     required: boolean;
-                    schema: {
-                        type: string;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
                     };
+                };
+            };
+        };
+        '/roles/{roleName}/users:list': {
+            get: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
                 }[];
                 responses: {
-                    '200': {
+                    200: {
                         description: string;
                         content: {
                             'application/json': {
                                 schema: {
                                     type: string;
-                                    items: {
-                                        type: string;
-                                        properties: {
-                                            type: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                            name: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                            collectionName: {
+                                    additionalProperties: boolean;
+                                    properties: {
+                                        data: {
+                                            type: string;
+                                            items: {
                                                 type: string;
-                                                description: string;
-                                            };
-                                            title: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                            roleName: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                            usingConfig: {
-                                                type: string;
-                                                enum: string[];
-                                                description: string;
-                                            };
-                                            exists: {
-                                                type: string;
-                                                description: string;
+                                                additionalProperties: boolean;
                                             };
                                         };
+                                        meta: {
+                                            type: string;
+                                            additionalProperties: boolean;
+                                        };
                                     };
                                 };
                             };
@@ -248,49 +233,61 @@ declare const _default: {
                 };
             };
         };
-        '/availableActions:list': {
+        '/roles/{roleName}/users:add': {
+            post: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/roles/{roleName}/users:remove': {
+            post: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/users/{userId}/roles:list': {
             get: {
                 tags: string[];
-                description: string;
-                parameters: any[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
                 responses: {
-                    '200': {
+                    200: {
                         description: string;
                         content: {
                             'application/json': {
                                 schema: {
                                     type: string;
-                                    items: {
-                                        type: string;
-                                        properties: {
-                                            name: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                            displayName: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                            allowConfigureFields: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                            onNewRecord: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                            type: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                            aliases: {
+                                    additionalProperties: boolean;
+                                    properties: {
+                                        data: {
+                                            type: string;
+                                            items: {
                                                 type: string;
-                                                items: {
-                                                    type: string;
-                                                };
-                                                description: string;
+                                                additionalProperties: boolean;
                                             };
                                         };
+                                        meta: {
+                                            type: string;
+                                            additionalProperties: boolean;
+                                        };
                                     };
                                 };
                             };
@@ -299,74 +296,896 @@ declare const _default: {
                 };
             };
         };
-    };
-    components: {
-        schemas: {
-            role: {
-                type: string;
-                properties: {
-                    title: {
-                        type: string;
-                        description: string;
-                    };
-                    name: {
-                        type: string;
+        '/users/{userId}/roles:add': {
+            post: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
                         description: string;
                     };
-                    description: {
-                        type: string;
+                };
+            };
+        };
+        '/users/{userId}/roles:remove': {
+            post: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
                         description: string;
                     };
-                    hidden: {
-                        type: string;
-                        description: string;
+                };
+            };
+        };
+        '/dataSources/{dataSourceKey}/roles:update': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
                     };
-                    default: {
-                        type: string;
+                };
+                responses: {
+                    200: {
                         description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
                     };
-                    allowConfigure: {
-                        type: string;
+                };
+            };
+        };
+        '/dataSources/{dataSourceKey}/roles:get': {
+            get: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
                         description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
                     };
-                    allowNewMenu: {
-                        type: string;
+                };
+            };
+        };
+        '/roles/{roleName}/dataSourcesCollections:list': {
+            get: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
                         description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        count: {
+                                            type: string;
+                                        };
+                                        rows: {
+                                            type: string;
+                                            items: {
+                                                $ref: string;
+                                            };
+                                        };
+                                        page: {
+                                            type: string;
+                                        };
+                                        pageSize: {
+                                            type: string;
+                                        };
+                                        totalPage: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
                     };
-                    snippets: {
-                        type: string;
-                        items: {
-                            type: string;
+                };
+            };
+        };
+        '/roles/{roleName}/dataSourceResources:create': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
                         };
-                        description: string;
                     };
-                    strategy: {
-                        type: string;
+                };
+                responses: {
+                    200: {
                         description: string;
-                        items: {
-                            type: string;
-                            properties: {
-                                actions: {
-                                    type: string;
-                                    items: {
-                                        type: string;
-                                    };
-                                    description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
                                 };
                             };
                         };
                     };
-                    createdAt: {
-                        type: string;
-                        format: string;
+                };
+            };
+        };
+        '/roles/{roleName}/dataSourceResources:get': {
+            get: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
                         description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
                     };
-                    updatedAt: {
+                };
+            };
+        };
+        '/roles/{roleName}/dataSourceResources: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;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/rolesResourcesScopes:list': {
+            get: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    items: {
+                                        $ref: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/rolesResourcesScopes:get': {
+            get: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/dataSources/{dataSourceKey}/rolesResourcesScopes: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;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/dataSources/{dataSourceKey}/rolesResourcesScopes:get': {
+            get: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/dataSources/{dataSourceKey}/rolesResourcesScopes:create': {
+            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;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/dataSources/{dataSourceKey}/rolesResourcesScopes:update': {
+            post: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/dataSources/{dataSourceKey}/rolesResourcesScopes:destroy': {
+            post: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/availableActions:list': {
+            get: {
+                tags: string[];
+                summary: string;
+                description: string;
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    items: {
+                                        $ref: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+    components: {
+        parameters: {
+            RoleNameQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                };
+            };
+            RoleNamePath: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                };
+            };
+            UserIdPath: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    anyOf: {
+                        type: string;
+                    }[];
+                };
+            };
+            DataSourceKeyPath: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                };
+            };
+            MembershipUserFilterByTkQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    anyOf: ({
+                        type: string;
+                        items?: undefined;
+                    } | {
+                        type: string;
+                        items: {
+                            anyOf: {
+                                type: string;
+                            }[];
+                        };
+                    })[];
+                };
+            };
+            MembershipRoleFilterByTkQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    anyOf: ({
+                        type: string;
+                        items?: undefined;
+                    } | {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    })[];
+                };
+            };
+            ResourceNameQuery: {
+                name: string;
+                in: string;
+                description: string;
+                required: boolean;
+                schema: {
+                    type: string;
+                };
+            };
+            ScopePkQuery: {
+                name: string;
+                in: string;
+                description: string;
+                schema: {
+                    type: string;
+                };
+            };
+            ResourcePermissionTkQuery: {
+                name: string;
+                in: string;
+                description: string;
+                schema: {
+                    type: string;
+                };
+            };
+            PageQuery: {
+                name: string;
+                in: string;
+                schema: {
+                    type: string;
+                };
+            };
+            PageSizeQuery: {
+                name: string;
+                in: string;
+                schema: {
+                    type: string;
+                };
+            };
+            FilterQuery: {
+                name: string;
+                in: string;
+                schema: {
+                    type: string;
+                    additionalProperties: boolean;
+                };
+            };
+            AppendsQuery: {
+                name: string;
+                in: string;
+                schema: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+            };
+        };
+        schemas: {
+            RoleStrategy: {
+                type: string;
+                description: string;
+                properties: {
+                    actions: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                        description: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            RoleWrite: {
+                type: string;
+                properties: {
+                    title: {
+                        type: string;
+                        description: string;
+                    };
+                    name: {
+                        type: string;
+                        description: string;
+                    };
+                    description: {
+                        type: string;
+                        description: string;
+                    };
+                    hidden: {
+                        type: string;
+                        description: string;
+                    };
+                    default: {
+                        type: string;
+                        description: string;
+                    };
+                    allowConfigure: {
+                        type: string;
+                        description: string;
+                    };
+                    allowNewMenu: {
+                        type: string;
+                        description: string;
+                    };
+                    snippets: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                        description: string;
+                    };
+                    strategy: {
+                        allOf: {
+                            $ref: string;
+                        }[];
+                        description: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            Role: {
+                allOf: {
+                    $ref: string;
+                }[];
+                properties: {
+                    createdAt: {
                         type: string;
                         format: string;
+                    };
+                    updatedAt: {
+                        type: string;
+                        format: string;
+                    };
+                };
+            };
+            RoleCheck: {
+                type: string;
+                properties: {
+                    role: {
+                        type: string;
+                        description: string;
+                    };
+                    roleMode: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                    availableActions: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    actions: {
+                        type: string;
+                        additionalProperties: boolean;
+                        description: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            RoleModeWrite: {
+                type: string;
+                properties: {
+                    roleMode: {
+                        type: string;
+                        enum: string[];
+                    };
+                };
+                required: string[];
+            };
+            DataSourceRole: {
+                type: string;
+                properties: {
+                    id: {
+                        type: string;
+                        description: string;
+                    };
+                    roleName: {
+                        type: string;
+                        description: string;
+                    };
+                    dataSourceKey: {
+                        type: string;
+                        description: string;
+                    };
+                    strategy: {
+                        allOf: {
+                            $ref: string;
+                        }[];
+                        description: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            RoleCollectionPermissionRow: {
+                type: string;
+                properties: {
+                    type: {
+                        type: string;
+                        description: string;
+                    };
+                    name: {
+                        type: string;
+                        description: string;
+                    };
+                    collectionName: {
+                        type: string;
+                        description: string;
+                    };
+                    title: {
+                        type: string;
+                        description: string;
+                    };
+                    roleName: {
+                        type: string;
+                        description: string;
+                    };
+                    usingConfig: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                    exists: {
+                        type: string;
+                        description: string;
+                    };
+                };
+            };
+            RoleResourceScope: {
+                type: string;
+                properties: {
+                    id: {
+                        type: string;
+                        description: string;
+                    };
+                    key: {
+                        type: string;
+                        description: string;
+                    };
+                    dataSourceKey: {
+                        type: string;
+                        nullable: boolean;
+                        description: string;
+                    };
+                    name: {
+                        type: string;
+                        description: string;
+                    };
+                    resourceName: {
+                        type: string;
+                        nullable: boolean;
+                        description: string;
+                    };
+                    scope: {
+                        type: string;
+                        additionalProperties: boolean;
+                        description: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            RoleResourceScopeWrite: {
+                type: string;
+                properties: {
+                    id: {
+                        type: string;
+                        description: string;
+                    };
+                    dataSourceKey: {
+                        type: string;
+                        nullable: boolean;
+                        description: string;
+                    };
+                    resourceName: {
+                        type: string;
+                        nullable: boolean;
+                        description: string;
+                    };
+                    name: {
+                        type: string;
+                        description: string;
+                    };
+                    scope: {
+                        type: string;
+                        additionalProperties: boolean;
+                        description: string;
+                    };
+                };
+                required: string[];
+                additionalProperties: boolean;
+            };
+            RoleResourceAction: {
+                type: string;
+                properties: {
+                    id: {
+                        type: string;
+                        description: string;
+                    };
+                    name: {
+                        type: string;
+                        description: string;
+                    };
+                    fields: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                        description: string;
+                    };
+                    scopeId: {
+                        type: string;
+                        nullable: boolean;
+                        description: string;
+                    };
+                    scope: {
+                        allOf: {
+                            $ref: string;
+                        }[];
+                        nullable: boolean;
+                        description: string;
+                    };
+                };
+                required: string[];
+                additionalProperties: boolean;
+            };
+            RoleDataSourceResourceWrite: {
+                type: string;
+                description: string;
+                properties: {
+                    id: {
+                        type: string;
+                        description: string;
+                    };
+                    name: {
+                        type: string;
+                        description: string;
+                    };
+                    dataSourceKey: {
+                        type: string;
+                        description: string;
+                    };
+                    roleName: {
+                        type: string;
+                        description: string;
+                    };
+                    usingActionsConfig: {
+                        type: string;
+                        description: string;
+                    };
+                    actions: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                        description: string;
+                    };
+                };
+                required: string[];
+                additionalProperties: boolean;
+            };
+            RoleDataSourceResource: {
+                allOf: {
+                    $ref: string;
+                }[];
+                properties: {
+                    id: {
+                        type: string;
+                    };
+                    roleName: {
+                        type: string;
+                    };
+                };
+            };
+            AvailableAction: {
+                type: string;
+                properties: {
+                    name: {
+                        type: string;
+                        description: string;
+                    };
+                    displayName: {
+                        type: string;
+                        description: string;
+                    };
+                    allowConfigureFields: {
+                        type: string;
+                        description: string;
+                    };
+                    onNewRecord: {
+                        type: string;
+                        description: string;
+                    };
+                    type: {
+                        type: string;
+                        description: string;
+                    };
+                    aliases: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
                         description: string;
                     };
                 };
+                additionalProperties: boolean;
             };
         };
     };