@leaflow/sdk 0.0.0-dev.11.g7f2d603

package/dist/iam/v1/schema.d.ts

@@ -0,0 +1,1230 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/api/v1/permissions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 列出 IAM 自己声明的权限
+         * @description **只有 IAM 这一份。** 别的服务的操作不在这里——权限目录由各个服务自己声明，IAM 认识它们就等于要跟着每个下游一起发版。
+         */
+        get: operations["list-permissions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/project": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 查看一个项目
+         * @description 在项目里就看得到，不需要额外的读权限。
+         */
+        get: operations["get-project"];
+        put?: never;
+        post?: never;
+        /**
+         * 删除项目
+         * @description 只有所有者能做，而且没有回头路：项目进入 DELETING，各服务开始清掉它下面的资源。项目行本身永远留着——查一个删掉的项目查得到，答案是它没了，而不是一个 404。
+         */
+        delete: operations["delete-project"];
+        options?: never;
+        head?: never;
+        /** 改项目的名称与描述 */
+        patch: operations["update-project"];
+        trace?: never;
+    };
+    "/api/v1/membership": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 查看我在这个项目里的身份
+         * @description 只给事实，不给结论：这里没有 allowed，因为 IAM 不知道你要做的是哪个操作——哪个操作需要哪条权限那份目录属于各个服务，判断在它们那边。
+         */
+        get: operations["get-project-membership"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/invitations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 列出这个项目还在等的要约
+         * @description 在项目里就看得到，和成员列表同一条规则：谁被请了也是「这个项目有谁」的一部分。
+         */
+        get: operations["list-project-invitations"];
+        put?: never;
+        /**
+         * 发出一份邀请
+         * @description 要约站 14 天。有上限是因为里面那些角色是按发出那一刻的项目校验的，一份活得比它所依据的安排还久的要约会授出现在没人打算授的权限。
+         */
+        post: operations["issue-invitation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/invitations/{invitationId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /** 撤回一份还没被兑现的要约 */
+        delete: operations["revoke-invitation"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/members": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** 列出项目成员 */
+        get: operations["list-members"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/members/{userId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * 移除成员，或者自己退出
+         * @description 移除别人要 iam:members.manage；退出只要求自己在这个项目里——任何人都可能被拉进一个项目，那么任何人就得能出去。所有者两条路都不行，先转移所有权。
+         */
+        delete: operations["remove-member"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/members/{userId}/roles": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * 设置一个成员持有的角色
+         * @description 整体替换而不是增删：调用方拿到的就是一份完整清单，让它自己算差集只会让「我以为我取消了那个角色」这种事变得可能。所有者身上的 OWNER 不受影响。
+         */
+        put: operations["set-member-roles"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/transfer-ownership": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * 转移项目所有权
+         * @description OWNER 唯一的移动方式，只有所有者本人能发起——能像普通角色那样授予的话，任何管理员都可以顺手把自己变成所有者。
+         */
+        post: operations["transfer-project-ownership"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/roles": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** 列出项目里的角色 */
+        get: operations["list-roles"];
+        put?: never;
+        /** 建一个角色 */
+        post: operations["create-role"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/roles/{code}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** 查看一个角色 */
+        get: operations["get-role"];
+        /**
+         * 改一个角色
+         * @description 名称、描述和权限整体替换。改完会在同一个事务里重新编译持有它的每一个成员——角色的权限变了，就是那些人的权限变了，而下一次请求是拿编译结果判定的。
+         */
+        put: operations["update-role"];
+        post?: never;
+        /**
+         * 删一个角色
+         * @description 还有人持有时会被拒。级联摘掉那些绑定等于把每个持有者悄悄降级——请求里没有一个字说了这件事，事后也查不到。
+         */
+        delete: operations["delete-role"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/ssh-keys": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 列出这个项目的公钥
+         * @description 归成员的和归项目的都在里面，靠每一条上的 owner_user_id 区分。
+         */
+        get: operations["list-ssh-keys"];
+        put?: never;
+        /**
+         * 添加一把公钥
+         * @description owner=me 是自己的，是成员就能加；owner=project 是项目公用的，要 iam:ssh_keys.manage —— 它会进这个项目之后开出来的每一台机器。
+         */
+        post: operations["create-ssh-key"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/ssh-keys/{keyId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** 查看一把公钥 */
+        get: operations["get-ssh-key"];
+        put?: never;
+        post?: never;
+        /**
+         * 吊销一把公钥
+         * @description 行留着，状态变成 REVOKED。事故之后要问的是当时信任的是哪把钥匙。
+         */
+        delete: operations["revoke-ssh-key"];
+        options?: never;
+        head?: never;
+        /**
+         * 给公钥改名
+         * @description 只有名字能改：公钥、类型、指纹是同一样东西的三种说法，改其中一个会让这一行描述一把并不存在的钥匙。
+         */
+        patch: operations["rename-ssh-key"];
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        Error: {
+            code?: string;
+            message: string;
+            meta?: {
+                [key: string]: unknown;
+            };
+            /** Format: int64 */
+            status: number;
+        };
+        PermissionResource: {
+            description: string;
+            name: string;
+            /** @description 只有项目所有者能做，绑到自定义角色上也不会生效 */
+            owner_only: boolean;
+        };
+        PermissionListResponseBody: {
+            items: components["schemas"]["PermissionResource"][] | null;
+        };
+        GrantResource: {
+            admin: boolean;
+            owner: boolean;
+            /** @description 持有的全部自定义角色的权限并集，已去重排序 */
+            permissions: string[] | null;
+            /** @description 持有的角色编码，只用于展示 */
+            roles: string[] | null;
+        };
+        ProjectResource: {
+            ban_reason: string;
+            /** Format: date-time */
+            created_at: string;
+            created_by: string;
+            /**
+             * Format: date-time
+             * @description 盖上墓碑的那一刻
+             */
+            deleted_at: string | null;
+            description: string;
+            /** Format: uuid */
+            id: string;
+            name: string;
+            /**
+             * Format: date-time
+             * @description 欠费的起始时间
+             */
+            overdue_at: string | null;
+            /** @enum {string} */
+            status: "ACTIVE" | "SUSPENDED" | "BANNED" | "DELETING" | "DELETED";
+            /** @description 给人看的，不参与任何查询 */
+            status_reason: string;
+            /** Format: date-time */
+            updated_at: string;
+        };
+        ProjectAccessResource: {
+            grant: components["schemas"]["GrantResource"];
+            project: components["schemas"]["ProjectResource"];
+        };
+        UpdateProjectRequestBody: {
+            description?: string;
+            name?: string;
+        };
+        MembershipResource: {
+            grant: components["schemas"]["GrantResource"];
+            member: boolean;
+            project_status: string;
+            user_status: string;
+        };
+        InvitationResource: {
+            /** Format: date-time */
+            created_at: string;
+            email: string;
+            /** Format: date-time */
+            expires_at: string;
+            /** Format: uuid */
+            id: string;
+            invited_by: string;
+            /** Format: uuid */
+            project_id: string;
+            /** @description 兑现时会授予的角色编码 */
+            roles: string[] | null;
+        };
+        LengthAwarePageInvitationResource: {
+            /** @description 这一页的内容 */
+            items: components["schemas"]["InvitationResource"][];
+            /**
+             * Format: int64
+             * @description 这一页最多几条，回显请求里的值
+             */
+            limit: number;
+            /**
+             * Format: int64
+             * @description 跳过了多少条，回显请求里的值
+             */
+            offset: number;
+            /**
+             * Format: int64
+             * @description 命中的总条数，不只是这一页
+             */
+            total: number;
+        };
+        IssueInvitationRequestBody: {
+            /** Format: email */
+            email: string;
+            /** @description 兑现时授予的角色编码。必须是这个项目已经定义的，OWNER 不行 */
+            roles: string[] | null;
+        };
+        IssuedInvitationResponseBody: {
+            invitation: components["schemas"]["InvitationResource"];
+            /** @description 兑现用的明文，**只在这一次响应里出现**。库里只有它的哈希，丢了只能撤销重发 */
+            token: string;
+        };
+        MemberResource: {
+            /** Format: date-time */
+            created_at: string;
+            created_by: string;
+            email: string;
+            first_name: string;
+            grant: components["schemas"]["GrantResource"];
+            last_name: string;
+            user_id: string;
+        };
+        LengthAwarePageMemberResource: {
+            /** @description 这一页的内容 */
+            items: components["schemas"]["MemberResource"][];
+            /**
+             * Format: int64
+             * @description 这一页最多几条，回显请求里的值
+             */
+            limit: number;
+            /**
+             * Format: int64
+             * @description 跳过了多少条，回显请求里的值
+             */
+            offset: number;
+            /**
+             * Format: int64
+             * @description 命中的总条数，不只是这一页
+             */
+            total: number;
+        };
+        SetMemberRolesRequestBody: {
+            /** @description 这个人应当持有的**全部**角色编码。OWNER 不能出现在这里 */
+            roles: string[] | null;
+        };
+        TransferOwnershipRequestBody: {
+            /** @description 接手的人必须已经是这个项目的成员 */
+            to_user_id: string;
+        };
+        OwnershipTransferResponseBody: {
+            /** @description 原所有者。他保留其余的角色——转让的是所有权，不是把人踢出去 */
+            from: components["schemas"]["MemberResource"];
+            to: components["schemas"]["MemberResource"];
+        };
+        RoleResource: {
+            /** @description 内置角色不可删、不可改权限：OWNER 和 ADMIN 的语义写在代码里 */
+            builtin: boolean;
+            code: string;
+            /** Format: date-time */
+            created_at: string;
+            description: string;
+            name: string;
+            permissions: string[] | null;
+            /** Format: date-time */
+            updated_at: string;
+        };
+        RoleListResponseBody: {
+            items: components["schemas"]["RoleResource"][] | null;
+        };
+        CreateRoleRequestBody: {
+            /** @description 小写字母开头，可含数字和下划线。建好之后不能改——成员绑定和邀请都指着它 */
+            code: string;
+            description?: string;
+            name: string;
+            /** @description 权限名。OwnerOnly 的那几条会被拒绝：绑上去也不会生效 */
+            permissions?: string[] | null;
+        };
+        UpdateRoleRequestBody: {
+            description?: string;
+            name: string;
+            permissions?: string[] | null;
+        };
+        SSHKeyResource: {
+            /** Format: date-time */
+            created_at: string;
+            fingerprint: string;
+            /** @description 平台生成并保管的那把。它的私钥不对外提供 */
+            has_private_key: boolean;
+            /** Format: uuid */
+            id: string;
+            key_type: string;
+            name: string;
+            /** @description 归属人；不给表示这把钥匙归项目本身 */
+            owner_user_id?: string;
+            public_key: string;
+            /** @description 用途标签。平台自己生成的那把是 platform */
+            purposes: string[] | null;
+            /** @enum {string} */
+            status: "ACTIVE" | "REVOKED";
+        };
+        LengthAwarePageSSHKeyResource: {
+            /** @description 这一页的内容 */
+            items: components["schemas"]["SSHKeyResource"][];
+            /**
+             * Format: int64
+             * @description 这一页最多几条，回显请求里的值
+             */
+            limit: number;
+            /**
+             * Format: int64
+             * @description 跳过了多少条，回显请求里的值
+             */
+            offset: number;
+            /**
+             * Format: int64
+             * @description 命中的总条数，不只是这一页
+             */
+            total: number;
+        };
+        CreateSSHKeyRequestBody: {
+            name: string;
+            /**
+             * @description 这把钥匙归谁
+             * @default me
+             * @enum {string}
+             */
+            owner: "me" | "project";
+            /** @description OpenSSH 格式的公钥。类型和指纹从它算出来，都不可改 */
+            public_key: string;
+            /** @description 用途标签，比如 ci、bastion */
+            purposes?: string[] | null;
+        };
+        RenameSSHKeyRequestBody: {
+            name: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    "list-permissions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PermissionListResponseBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-project": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProjectAccessResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "delete-project": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProjectAccessResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "update-project": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateProjectRequestBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProjectAccessResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-project-membership": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MembershipResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-project-invitations": {
+        parameters: {
+            query?: {
+                /** @description 这一页最多返回多少条 */
+                limit?: number;
+                /** @description 跳过多少条。要翻得更深请改用游标翻页的接口 */
+                offset?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LengthAwarePageInvitationResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "issue-invitation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["IssueInvitationRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["IssuedInvitationResponseBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "revoke-invitation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                invitationId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-members": {
+        parameters: {
+            query?: {
+                /** @description 这一页最多返回多少条 */
+                limit?: number;
+                /** @description 跳过多少条。要翻得更深请改用游标翻页的接口 */
+                offset?: number;
+                /** @description 按用户 ID、邮箱或姓名模糊匹配 */
+                keyword?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LengthAwarePageMemberResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "remove-member": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                userId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "set-member-roles": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                userId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SetMemberRolesRequestBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MemberResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "transfer-project-ownership": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["TransferOwnershipRequestBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OwnershipTransferResponseBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-roles": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RoleListResponseBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "create-role": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateRoleRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RoleResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-role": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                code: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RoleResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "update-role": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                code: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateRoleRequestBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RoleResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "delete-role": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                code: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-ssh-keys": {
+        parameters: {
+            query?: {
+                /** @description 这一页最多返回多少条 */
+                limit?: number;
+                /** @description 跳过多少条。要翻得更深请改用游标翻页的接口 */
+                offset?: number;
+                /** @description 不传时两种都返回 */
+                status?: "ACTIVE" | "REVOKED";
+                /** @description 只列挂着这个用途的钥匙。平台自己生成的那把是 platform */
+                purpose?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LengthAwarePageSSHKeyResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "create-ssh-key": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateSSHKeyRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SSHKeyResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-ssh-key": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                keyId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SSHKeyResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "revoke-ssh-key": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                keyId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SSHKeyResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "rename-ssh-key": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                keyId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RenameSSHKeyRequestBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SSHKeyResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+}