@leaflow/sdk 0.2.0 → 0.4.0

package/openapi/iam.yaml

@@ -179,19 +179,6 @@ components:
       required:
         - name
       type: object
-    CreateProjectSSHKeyRequestBody:
-      additionalProperties: false
-      properties:
-        name:
-          maxLength: 128
-          type: string
-        public_key:
-          maxLength: 16384
-          type: string
-      required:
-        - name
-        - public_key
-      type: object
     CreateRoleRequestBody:
       additionalProperties: false
       properties:
@@ -216,16 +203,31 @@ components:
         - code
         - name
       type: object
-    CreateUserSSHKeyRequestBody:
+    CreateSSHKeyRequestBody:
       additionalProperties: false
       properties:
         name:
           maxLength: 128
           type: string
+        owner:
+          default: me
+          description: 这把钥匙归谁
+          enum:
+            - me
+            - project
+          type: string
         public_key:
           description: OpenSSH 格式的公钥。类型和指纹从它算出来，都不可改
           maxLength: 16384
           type: string
+        purposes:
+          description: 用途标签，比如 ci、bastion
+          items:
+            type: string
+          maxItems: 16
+          type:
+            - array
+            - "null"
       required:
         - name
         - public_key
@@ -304,22 +306,6 @@ components:
         - verified_at
         - reject_reason
       type: object
-    InvitationListResponseBody:
-      additionalProperties: false
-      properties:
-        items:
-          items:
-            $ref: "#/components/schemas/InvitationResource"
-          type:
-            - array
-            - "null"
-        total:
-          format: int64
-          type: integer
-      required:
-        - items
-        - total
-      type: object
     InvitationResource:
       additionalProperties: false
       properties:
@@ -386,21 +372,109 @@ components:
         - invitation
         - token
       type: object
-    MemberListResponseBody:
+    LengthAwarePageInvitationResource:
       additionalProperties: false
       properties:
         items:
+          description: 这一页的内容
+          items:
+            $ref: "#/components/schemas/InvitationResource"
+          type: array
+        limit:
+          description: 这一页最多几条，回显请求里的值
+          format: int64
+          type: integer
+        offset:
+          description: 跳过了多少条，回显请求里的值
+          format: int64
+          type: integer
+        total:
+          description: 命中的总条数，不只是这一页
+          format: int64
+          type: integer
+      required:
+        - items
+        - total
+        - limit
+        - offset
+      type: object
+    LengthAwarePageMemberResource:
+      additionalProperties: false
+      properties:
+        items:
+          description: 这一页的内容
           items:
             $ref: "#/components/schemas/MemberResource"
-          type:
-            - array
-            - "null"
+          type: array
+        limit:
+          description: 这一页最多几条，回显请求里的值
+          format: int64
+          type: integer
+        offset:
+          description: 跳过了多少条，回显请求里的值
+          format: int64
+          type: integer
+        total:
+          description: 命中的总条数，不只是这一页
+          format: int64
+          type: integer
+      required:
+        - items
+        - total
+        - limit
+        - offset
+      type: object
+    LengthAwarePageProjectAccessResource:
+      additionalProperties: false
+      properties:
+        items:
+          description: 这一页的内容
+          items:
+            $ref: "#/components/schemas/ProjectAccessResource"
+          type: array
+        limit:
+          description: 这一页最多几条，回显请求里的值
+          format: int64
+          type: integer
+        offset:
+          description: 跳过了多少条，回显请求里的值
+          format: int64
+          type: integer
+        total:
+          description: 命中的总条数，不只是这一页
+          format: int64
+          type: integer
+      required:
+        - items
+        - total
+        - limit
+        - offset
+      type: object
+    LengthAwarePageSSHKeyResource:
+      additionalProperties: false
+      properties:
+        items:
+          description: 这一页的内容
+          items:
+            $ref: "#/components/schemas/SSHKeyResource"
+          type: array
+        limit:
+          description: 这一页最多几条，回显请求里的值
+          format: int64
+          type: integer
+        offset:
+          description: 跳过了多少条，回显请求里的值
+          format: int64
+          type: integer
         total:
+          description: 命中的总条数，不只是这一页
           format: int64
           type: integer
       required:
         - items
         - total
+        - limit
+        - offset
       type: object
     MemberResource:
       additionalProperties: false
@@ -485,22 +559,6 @@ components:
         - description
         - owner_only
       type: object
-    ProjectAccessListResponseBody:
-      additionalProperties: false
-      properties:
-        items:
-          items:
-            $ref: "#/components/schemas/ProjectAccessResource"
-          type:
-            - array
-            - "null"
-        total:
-          format: int64
-          type: integer
-      required:
-        - items
-        - total
-      type: object
     ProjectAccessResource:
       additionalProperties: false
       properties:
@@ -612,16 +670,7 @@ components:
       required:
         - consents
       type: object
-    RenameProjectSSHKeyRequestBody:
-      additionalProperties: false
-      properties:
-        name:
-          maxLength: 128
-          type: string
-      required:
-        - name
-      type: object
-    RenameUserSSHKeyRequestBody:
+    RenameSSHKeyRequestBody:
       additionalProperties: false
       properties:
         name:
@@ -675,22 +724,6 @@ components:
         - created_at
         - updated_at
       type: object
-    SSHKeyListResponseBody:
-      additionalProperties: false
-      properties:
-        items:
-          items:
-            $ref: "#/components/schemas/SSHKeyResource"
-          type:
-            - array
-            - "null"
-        total:
-          format: int64
-          type: integer
-      required:
-        - items
-        - total
-      type: object
     SSHKeyResource:
       additionalProperties: false
       properties:
@@ -699,6 +732,9 @@ components:
           type: string
         fingerprint:
           type: string
+        has_private_key:
+          description: 平台生成并保管的那把。它的私钥不对外提供
+          type: boolean
         id:
           format: uuid
           type: string
@@ -706,8 +742,18 @@ components:
           type: string
         name:
           type: string
+        owner_user_id:
+          description: 归属人；不给表示这把钥匙归项目本身
+          type: string
         public_key:
           type: string
+        purposes:
+          description: 用途标签。平台自己生成的那把是 platform
+          items:
+            type: string
+          type:
+            - array
+            - "null"
         status:
           enum:
             - ACTIVE
@@ -721,6 +767,8 @@ components:
         - key_type
         - status
         - created_at
+        - purposes
+        - has_private_key
       type: object
     SetMemberRolesRequestBody:
       additionalProperties: false
@@ -789,6 +837,12 @@ components:
       required:
         - name
       type: object
+  securitySchemes:
+    bearerAuth:
+      bearerFormat: JWT
+      description: 项目令牌。先在 auth.leaflow.net 登录拿到账号令牌，再用它向 IAM 换取项目令牌（POST /api/v1/projects/{projectId}/token）——一张项目令牌同时说明当前用户和当前项目。
+      scheme: bearer
+      type: http
 info:
   description: |-
     用户和项目自己用的接口：账号、项目、成员、角色、邀请、SSH 公钥。
@@ -998,24 +1052,25 @@ paths:
           schema:
             description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
             type: string
-        - description: 这一页最多返回多少条，0 表示用默认值
+        - description: 这一页最多返回多少条
           explode: false
           in: query
           name: limit
           schema:
             default: 50
-            description: 这一页最多返回多少条，0 表示用默认值
+            description: 这一页最多返回多少条
             format: int64
-            maximum: 100
-            minimum: 0
+            maximum: 200
+            minimum: 1
             type: integer
-        - description: 跳过多少条
+        - description: 跳过多少条。要翻得更深请改用游标翻页的接口
           explode: false
           in: query
           name: offset
           schema:
-            description: 跳过多少条
+            description: 跳过多少条。要翻得更深请改用游标翻页的接口
             format: int64
+            maximum: 10000
             minimum: 0
             type: integer
       responses:
@@ -1023,7 +1078,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/InvitationListResponseBody"
+                $ref: "#/components/schemas/LengthAwarePageInvitationResource"
           description: OK
         default:
           content:
@@ -1102,200 +1157,6 @@ paths:
       summary: 接受一份列在我名下的要约
       tags:
         - Invitation
-  /api/v1/me/ssh-keys:
-    get:
-      operationId: list-my-ssh-keys
-      parameters:
-        - description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
-            type: string
-        - description: 这一页最多返回多少条，0 表示用默认值
-          explode: false
-          in: query
-          name: limit
-          schema:
-            default: 50
-            description: 这一页最多返回多少条，0 表示用默认值
-            format: int64
-            maximum: 100
-            minimum: 0
-            type: integer
-        - description: 跳过多少条
-          explode: false
-          in: query
-          name: offset
-          schema:
-            description: 跳过多少条
-            format: int64
-            minimum: 0
-            type: integer
-        - description: 不传时两种都返回
-          explode: false
-          in: query
-          name: status
-          schema:
-            description: 不传时两种都返回
-            enum:
-              - ACTIVE
-              - REVOKED
-            type: string
-      responses:
-        "200":
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/SSHKeyListResponseBody"
-          description: OK
-        default:
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/Error"
-          description: Error
-      summary: 列出我的公钥
-      tags:
-        - SSHKey
-    post:
-      operationId: create-my-ssh-key
-      parameters:
-        - description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
-            type: string
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/CreateUserSSHKeyRequestBody"
-        required: true
-      responses:
-        "201":
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/SSHKeyResource"
-          description: Created
-        default:
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/Error"
-          description: Error
-      summary: 添加一把我的公钥
-      tags:
-        - SSHKey
-  /api/v1/me/ssh-keys/{keyId}:
-    delete:
-      description: 行留着，状态变成 REVOKED。事故之后要问的是当时信任的是哪把钥匙。
-      operationId: revoke-my-ssh-key
-      parameters:
-        - description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
-            type: string
-        - in: path
-          name: keyId
-          required: true
-          schema:
-            format: uuid
-            type: string
-      responses:
-        "200":
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/SSHKeyResource"
-          description: OK
-        default:
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/Error"
-          description: Error
-      summary: 吊销我的一把公钥
-      tags:
-        - SSHKey
-    get:
-      operationId: get-my-ssh-key
-      parameters:
-        - description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
-            type: string
-        - in: path
-          name: keyId
-          required: true
-          schema:
-            format: uuid
-            type: string
-      responses:
-        "200":
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/SSHKeyResource"
-          description: OK
-        default:
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/Error"
-          description: Error
-      summary: 查看我的一把公钥
-      tags:
-        - SSHKey
-    patch:
-      description: 只有名字能改：公钥、类型、指纹是同一样东西的三种说法，改其中一个会让这一行描述一把并不存在的钥匙。
-      operationId: rename-my-ssh-key
-      parameters:
-        - description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
-            type: string
-        - in: path
-          name: keyId
-          required: true
-          schema:
-            format: uuid
-            type: string
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/RenameUserSSHKeyRequestBody"
-        required: true
-      responses:
-        "200":
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/SSHKeyResource"
-          description: OK
-        default:
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/Error"
-          description: Error
-      summary: 给我的公钥改名
-      tags:
-        - SSHKey
   /api/v1/permissions:
     get:
       description: "**只有 IAM 这一份。** 别的服务的操作不在这里——权限目录是各服务各自声明、由 各个服务自己声明的，IAM 认识它们就等于要跟着每个下游一起发版。"
@@ -1328,24 +1189,25 @@ paths:
           schema:
             description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
             type: string
-        - description: 这一页最多返回多少条，0 表示用默认值
+        - description: 这一页最多返回多少条
           explode: false
           in: query
           name: limit
           schema:
             default: 50
-            description: 这一页最多返回多少条，0 表示用默认值
+            description: 这一页最多返回多少条
             format: int64
-            maximum: 100
-            minimum: 0
+            maximum: 200
+            minimum: 1
             type: integer
-        - description: 跳过多少条
+        - description: 跳过多少条。要翻得更深请改用游标翻页的接口
           explode: false
           in: query
           name: offset
           schema:
-            description: 跳过多少条
+            description: 跳过多少条。要翻得更深请改用游标翻页的接口
             format: int64
+            maximum: 10000
             minimum: 0
             type: integer
         - description: 按名称或描述模糊匹配
@@ -1374,7 +1236,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/ProjectAccessListResponseBody"
+                $ref: "#/components/schemas/LengthAwarePageProjectAccessResource"
           description: OK
         default:
           content:
@@ -1535,24 +1397,25 @@ paths:
           schema:
             description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
             type: string
-        - description: 这一页最多返回多少条，0 表示用默认值
+        - description: 这一页最多返回多少条
           explode: false
           in: query
           name: limit
           schema:
             default: 50
-            description: 这一页最多返回多少条，0 表示用默认值
+            description: 这一页最多返回多少条
             format: int64
-            maximum: 100
-            minimum: 0
+            maximum: 200
+            minimum: 1
             type: integer
-        - description: 跳过多少条
+        - description: 跳过多少条。要翻得更深请改用游标翻页的接口
           explode: false
           in: query
           name: offset
           schema:
-            description: 跳过多少条
+            description: 跳过多少条。要翻得更深请改用游标翻页的接口
             format: int64
+            maximum: 10000
             minimum: 0
             type: integer
         - in: path
@@ -1566,7 +1429,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/InvitationListResponseBody"
+                $ref: "#/components/schemas/LengthAwarePageInvitationResource"
           description: OK
         default:
           content:
@@ -1662,24 +1525,25 @@ paths:
           schema:
             description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
             type: string
-        - description: 这一页最多返回多少条，0 表示用默认值
+        - description: 这一页最多返回多少条
           explode: false
           in: query
           name: limit
           schema:
             default: 50
-            description: 这一页最多返回多少条，0 表示用默认值
+            description: 这一页最多返回多少条
             format: int64
-            maximum: 100
-            minimum: 0
+            maximum: 200
+            minimum: 1
             type: integer
-        - description: 跳过多少条
+        - description: 跳过多少条。要翻得更深请改用游标翻页的接口
           explode: false
           in: query
           name: offset
           schema:
-            description: 跳过多少条
+            description: 跳过多少条。要翻得更深请改用游标翻页的接口
             format: int64
+            maximum: 10000
             minimum: 0
             type: integer
         - in: path
@@ -1701,7 +1565,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/MemberListResponseBody"
+                $ref: "#/components/schemas/LengthAwarePageMemberResource"
           description: OK
         default:
           content:
@@ -2020,7 +1884,8 @@ paths:
         - Role
   /api/v1/projects/{projectId}/ssh-keys:
     get:
-      operationId: list-project-ssh-keys
+      description: 归成员的和归项目的都在里面，靠每一条上的 owner_user_id 区分。
+      operationId: list-ssh-keys
       parameters:
         - description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
           in: header
@@ -2029,24 +1894,25 @@ paths:
           schema:
             description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
             type: string
-        - description: 这一页最多返回多少条，0 表示用默认值
+        - description: 这一页最多返回多少条
           explode: false
           in: query
           name: limit
           schema:
             default: 50
-            description: 这一页最多返回多少条，0 表示用默认值
+            description: 这一页最多返回多少条
             format: int64
-            maximum: 100
-            minimum: 0
+            maximum: 200
+            minimum: 1
             type: integer
-        - description: 跳过多少条
+        - description: 跳过多少条。要翻得更深请改用游标翻页的接口
           explode: false
           in: query
           name: offset
           schema:
-            description: 跳过多少条
+            description: 跳过多少条。要翻得更深请改用游标翻页的接口
             format: int64
+            maximum: 10000
             minimum: 0
             type: integer
         - in: path
@@ -2055,20 +1921,30 @@ paths:
           schema:
             format: uuid
             type: string
-        - explode: false
+        - description: 不传时两种都返回
+          explode: false
           in: query
           name: status
           schema:
+            description: 不传时两种都返回
             enum:
               - ACTIVE
               - REVOKED
             type: string
+        - description: 只列挂着这个用途的钥匙。平台自己生成的那把是 platform
+          explode: false
+          in: query
+          name: purpose
+          schema:
+            description: 只列挂着这个用途的钥匙。平台自己生成的那把是 platform
+            maxLength: 64
+            type: string
       responses:
         "200":
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/SSHKeyListResponseBody"
+                $ref: "#/components/schemas/LengthAwarePageSSHKeyResource"
           description: OK
         default:
           content:
@@ -2076,11 +1952,12 @@ paths:
               schema:
                 $ref: "#/components/schemas/Error"
           description: Error
-      summary: 列出项目的公钥
+      summary: 列出这个项目的公钥
       tags:
         - SSHKey
     post:
-      operationId: create-project-ssh-key
+      description: owner=me 是自己的，是成员就能加；owner=project 是项目公用的，要 iam:ssh_keys.manage —— 它会进这个项目之后开出来的每一台机器。
+      operationId: create-ssh-key
       parameters:
         - description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
           in: header
@@ -2099,7 +1976,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/CreateProjectSSHKeyRequestBody"
+              $ref: "#/components/schemas/CreateSSHKeyRequestBody"
         required: true
       responses:
         "201":
@@ -2114,12 +1991,13 @@ paths:
               schema:
                 $ref: "#/components/schemas/Error"
           description: Error
-      summary: 给项目添加一把公钥
+      summary: 添加一把公钥
       tags:
         - SSHKey
   /api/v1/projects/{projectId}/ssh-keys/{keyId}:
     delete:
-      operationId: revoke-project-ssh-key
+      description: 行留着，状态变成 REVOKED。事故之后要问的是当时信任的是哪把钥匙。
+      operationId: revoke-ssh-key
       parameters:
         - description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
           in: header
@@ -2153,11 +2031,11 @@ paths:
               schema:
                 $ref: "#/components/schemas/Error"
           description: Error
-      summary: 吊销项目的一把公钥
+      summary: 吊销一把公钥
       tags:
         - SSHKey
     get:
-      operationId: get-project-ssh-key
+      operationId: get-ssh-key
       parameters:
         - description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
           in: header
@@ -2191,11 +2069,12 @@ paths:
               schema:
                 $ref: "#/components/schemas/Error"
           description: Error
-      summary: 查看项目的一把公钥
+      summary: 查看一把公钥
       tags:
         - SSHKey
     patch:
-      operationId: rename-project-ssh-key
+      description: 只有名字能改：公钥、类型、指纹是同一样东西的三种说法，改其中一个会让这一行描述一把并不存在的钥匙。
+      operationId: rename-ssh-key
       parameters:
         - description: Bearer 令牌。选定项目之前用 auth.leaflow.net 签发的账号令牌，选定之后用项目令牌
           in: header
@@ -2220,7 +2099,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/RenameProjectSSHKeyRequestBody"
+              $ref: "#/components/schemas/RenameSSHKeyRequestBody"
         required: true
       responses:
         "200":
@@ -2235,7 +2114,7 @@ paths:
               schema:
                 $ref: "#/components/schemas/Error"
           description: Error
-      summary: 给项目的公钥改名
+      summary: 给公钥改名
       tags:
         - SSHKey
   /api/v1/projects/{projectId}/token:
@@ -2358,4 +2237,6 @@ paths:
       summary: 注册账号
       tags:
         - Account
+security:
+  - bearerAuth: []