Merge branch 'v11.0' into v12.0

Author: r350178982

api/admin_account_operations.yaml

@@ -3,7 +3,7 @@ info:
   title: Account Operations - System Admin
   description: |-
     The official SeaTable API Reference (OpenAPI 3.0). - Part 'User Account Operations'.
-  version: '11'
+  version: '11.0'
 servers:
   - url: https://{server}
     variables: 
@@ -263,6 +263,15 @@ components:
       org_name: 
         type: string
         description: organization name
+      
+      org_quota:
+        type: integer
+        description: Max quota an organization can use.
+
+      org_member_limit:
+        type: integer
+        description: Max user numbers an organization can use. The 'ORG_MEMBER_QUOTA_ENABLED' should be set to true in the config file.
+
 
 
     # response schemas
@@ -2810,6 +2819,11 @@ paths:
                   $ref: '#/components/schemas/email'
                 owner_password: 
                   $ref: '#/components/schemas/password'
+                quota:
+                  $ref: '#/components/schemas/org_quota'
+                member_limit:
+                  $ref: '#/components/schemas/org_member_limit'
+
       responses:
         '200': 
           description: OK

api/authentication.yaml

@@ -3,12 +3,12 @@ info:
   title: authentication
   description: |-
     The official Seafile API Reference
-  version: '11'
+  version: '11.0'
 tags:
   - name: Account-Token
     description: Access library with Account-Token
   - name: Repo-Token
-    description: Access library with Repo-Token
+    description: Access library with Repo API Token
 servers:
   - url: https://{server}
     variables:
@@ -28,6 +28,17 @@ components:
       scheme: bearer
       description: This is the [API-Token](/reference/authentication).
       bearerFormat: API-Token
+  
+  parameters:
+    X-SEAFILE-OTP:
+      name: X-SEAFILE-OTP
+      in: header
+      schema:
+        type: string
+        pattern: '^\d{6}$'
+      description: >
+        Two-factor token (usually generated with a mobile app like the
+        google authenticator), optional, only needed if 2FA is activated for your account.
 
   schemas:
     AccountTokenResponse:
@@ -71,7 +82,9 @@ paths:
       summary: Obtain account token
       tags:
         - Account-Token
-      description: Obtain account token with username and password
+      description: |
+        Generate an *Account-Token* with your username and password. This Account-Token is necessary for all the following account operations.
+        Use the optional paramater if two-factor-authentication (2FA) is activated for your account.
       security: []
       requestBody:
         content:
@@ -88,6 +101,8 @@ paths:
               required:
                 - username
                 - password
+      parameters:
+        - $ref: "#/components/parameters/X-SEAFILE-OTP"
       responses:
         '200':
           description: OK

api/ping_and_info.yaml

@@ -3,7 +3,7 @@ info:
   title: Ping and Server Info
   description: >-
     The official Seafile API Reference (OpenAPI 3.0) - Part 'Ping and Server Info'.
-  version: '11'
+  version: '11.0'
 servers:
   - url: 'https://{server}'
     variables:

api/repo-api-tokens.yaml

@@ -3,7 +3,7 @@ info:
   title: Via Repo-Token
   description: |-
     Access library Via Repo-Token
-  version: '11'
+  version: '11.0'
 tags:
   - name: Via Repo-Token
     description: Access library Via Repo-Token

api/user_account_operations.yaml

@@ -3,7 +3,7 @@ info:
   title: Account Operations - User
   description: |-
     The official SeaTable API Reference (OpenAPI 3.0). - Part 'User Account Operations'.
-  version: '11'
+  version: '11.0'
 servers:
   - url: https://{server}
     variables: 
@@ -7856,7 +7856,7 @@ paths:
   /api/v2.1/repos/batch/: 
     post:
       tags:
-        - Share batch operation
+        - Share to user/group
       summary: Batch share libraries to user/group
       description: Batch sharing existing libraries with user/group.
       security:
@@ -7925,7 +7925,7 @@ paths:
   /api2/repos/{repo_id}/dir/shared_items/p={path}:
     put: 
       tags:
-        - Share folder
+        - Share to user/group
       summary: Share a folder
       description: |-
         Share folders with other users and groups.
@@ -8000,7 +8000,7 @@ paths:
   /api/v2.1/shared-folders/:
     get: 
       tags:
-        - Share folder
+        - Share to user/group
       summary: List shared folders
       description: Return all shared folder information.
       security:
@@ -8066,7 +8066,7 @@ paths:
   /api2/repos/{repo_id}/dir/shared_items/?p={path}:
     post: 
       tags:
-        - Share folder
+        - Share to user/group
       summary: Update folder share permission
       description: |-
         Update shared folder permissions.
@@ -8104,7 +8104,7 @@ paths:
 
     delete: 
       tags:
-        - Share folder
+        - Share to user/group
       summary: Remove the specified shared folder
       description: |-
         - username, necessary if share_type is user