Add audit logs + tests

.github/readme-ids.json

@@ -1,11 +1,11 @@
 {
-  "version": "6.1",
-  "authentication": "6978dfd7217b10efe565eeee",
-  "base_operations": "6978dfd7217b10efe565eef6",
-  "file_operations": "6978dfd7217b10efe565eef5",
-  "system_admin_account_operations": "6978dfd7217b10efe565eef2",
-  "team_admin_account_operations": "6978dfd7217b10efe565eef1",
-  "user_account_operations": "6978dfd7217b10efe565eef3",
-  "ping_and_info": "6978dfd7217b10efe565eef0",
-  "python_scheduler": "6978dfd7217b10efe565eef4"
+  "version": "6.2",
+  "authentication": "69d4dc0c1422831f8d6fbb8e",
+  "base_operations": "69d4dc0c1422831f8d6fbb96",
+  "file_operations": "69d4dc0c1422831f8d6fbb95",
+  "system_admin_account_operations": "69d4dc0c1422831f8d6fbb92",
+  "team_admin_account_operations": "69d4dc0c1422831f8d6fbb91",
+  "user_account_operations": "69d4dc0c1422831f8d6fbb93",
+  "ping_and_info": "69d4dc0c1422831f8d6fbb90",
+  "python_scheduler": "69d4dc0c1422831f8d6fbb94"
 }

.github/sync-with-postman.sh

@@ -33,10 +33,11 @@ jq '{"collection": .}' < postman/collection.json > postman/collection.wrapped.js
 
 DESCRIPTION="This is the reference for the SeaTable API. On this page you will find everything you need to know to use SeaTable's API.
 
-    The SeaTable API is organized around REST. This means: SeaTable's API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
+The SeaTable API is organized around REST. This means: SeaTable's API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
 
-    With SeaTable, you can design individual databases, workflows and apps in no time at all - without any programming knowledge.
-    Our no-code solution combines the intuitive operation of tables with the power of modern database and app builder functions and also impresses as a flexible low-code platform for all users.
+With SeaTable, you can design individual databases, workflows and apps in no time at all - without any programming knowledge.
+
+Our no-code solution combines the intuitive operation of tables with the power of modern database and app builder functions and also impresses as a flexible low-code platform for all users.
 "
 
 # Set description (required for Postman verification)

.github/workflows/api-tests.yml

@@ -28,8 +28,8 @@ on:
           - "seatable/seatable-enterprise-testing"
 
 env:
-  DEFAULT_VERSION: "6.1.8"
-  DEFAULT_IMAGE: "seatable/seatable-enterprise"
+  DEFAULT_VERSION: "6.2.12"
+  DEFAULT_IMAGE: "seatable/seatable-enterprise-testing"
 
 
 jobs:

.github/workflows/rdme-openapi.yml

@@ -10,13 +10,13 @@
 # Process for new version:
 #   1. git checkout -b vX.Y
 #   2. Login to https://dash.readme.com/login and fork the API definition to the new version.
-#   3. Get the new category IDs from https://dash.readme.com/project/seatable/vX.Y/reference
-#      or via API: https://docs.readme.com/main/reference/getcategories
+#   3a. Get the new category IDs from https://dash.readme.com/project/seatable/vX.Y/reference
+#   3b. Update .github/readme-ids.json with the new IDs.
+#   4a. Get the _id (of SeaTable API) via API: https://docs.readme.com/main/reference/getcategories
 #      (use the API key from https://dash.readme.com/project/seatable/vX.Y/api-key as password - username stays empty)
-#   4. Update .github/readme-ids.json with the new IDs.
-#   5. Update the "category" value in all intro/*.md frontmatter.
-#   6. Update the version in all YAML spec files.
-#   7. git add . && git commit && git push --set-upstream origin vX.Y
+#   4b. Update the "category" value in all intro/*.md frontmatter.
+#   5. Update the version in all YAML spec files.
+#   6. git add . && git commit && git push --set-upstream origin vX.Y
 
 name: Publish
 

authentication.yaml

@@ -3,7 +3,7 @@ info:
   title: Authentication
   description: >-
     The official SeaTable API Reference (OpenAPI 3.0).
-  version: "6.1"
+  version: "6.2"
 servers:
   - url: "https://{server}"
     variables:

base_operations.yaml

@@ -3,7 +3,7 @@ info:
   title: Base Operations
   description: >-
     The official SeaTable API Reference (OpenAPI 3.0).
-  version: "6.1"
+  version: "6.2"
 servers:
   - url: "https://{server}"
     variables:
@@ -3348,6 +3348,12 @@ paths:
                 link_rows: {}
                 summaries: {}
                 colors: {}
+        "400":
+          description: A view with this name already exists in the table.
+          content:
+            application/json:
+              example:
+                error_msg: params invalid
   /api-gateway/api/v2/dtables/{base_uuid}/views/{view_name}/:
     get:
       tags:
@@ -3549,6 +3555,12 @@ paths:
                 link_rows: {}
                 summaries: {}
                 colors: {}
+        "400":
+          description: The target view name already exists in the table.
+          content:
+            application/json:
+              example:
+                error_msg: params invalid
     delete:
       tags:
         - Views
@@ -3702,6 +3714,11 @@ paths:
                   conditions: []
                 permission_type: ""
                 permitted_users: []
+        "400":
+          description: A column with this name already exists in the table.
+          content:
+            application/json:
+              example: Column ColA exists.
     put:
       tags:
         - Columns
@@ -3773,6 +3790,13 @@ paths:
                 data: null
                 permission_type: ""
                 permitted_users: []
+        "400":
+          description: A column with this name already exists in the table.
+          content:
+            application/json:
+              example:
+                error_type: column_already_exists
+                error_message: column name already exists
     delete:
       tags:
         - Columns
@@ -4288,7 +4312,9 @@ paths:
           content:
             application/json:
               schema:
-                type: object
+                type: array
+                items:
+                  type: object
               example:
                 - id: 1
                   author: 28d006e7d1754bb4afa2c2cb7369d244@auth.local
@@ -4314,20 +4340,41 @@ paths:
                   created_at: "2021-01-15T13:53:13.000Z"
                   updated_at: "2021-01-15T13:53:13.000Z"
                   resolved: 1
+    post:
+      tags:
+        - Row Comments
+      summary: Create Row Comment
+      operationId: createRowComment
+      description: >-
+        Create a comment for a certain row.
+      security:
+        - BaseTokenAuth: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/create_row_comment"
+      parameters:
+        - $ref: "#/components/parameters/base_uuid"
+        - $ref: "#/components/parameters/table_id"
+        - $ref: "#/components/parameters/row_id"
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+              example:
+                success:true
   /api-gateway/api/v2/dtables/{base_uuid}/comments/{comment_id}/:
     delete:
       tags:
         - Row Comments
       summary: Delete Comment
       operationId: deleteComment
       deprecated: true
-      description: >-
-        Delete a certain comment by its ID.
-
-
-        > 🚧 Creating comments via the API Gateway is not yet supported.
-        This will be fixed in SeaTable 6.2. Until then, comments can only be
-        created via `POST /api/v2.1/dtables/{dtable_uuid}/comments/` (dtable-web).
+      description: Delete a certain comment by its ID.
       security:
         - BaseTokenAuth: []
       parameters:
@@ -4348,13 +4395,7 @@ paths:
       summary: Get Comment
       operationId: getComment
       deprecated: true
-      description: >-
-        Get the details of a certain comment with its ID.
-
-
-        > 🚧 Creating comments via the API Gateway is not yet supported.
-        This will be fixed in SeaTable 6.2. Until then, comments can only be
-        created via `POST /api/v2.1/dtables/{dtable_uuid}/comments/` (dtable-web).
+      description: Get the details of a certain comment with its ID.
       security:
         - BaseTokenAuth: []
       parameters:

file_operations.yaml

@@ -3,7 +3,7 @@ info:
   title: File Operations
   description: >-
     The official SeaTable API Reference (OpenAPI 3.0).
-  version: "6.1"
+  version: "6.2"
 servers:
   - url: "https://{server}"
     variables:
@@ -263,8 +263,8 @@ paths:
               example:
                 download_link: >-
                   https://cloud.seatable.io/seafhttp/files/12345678-1234-4672-834c-4eca40dc104b/test.png
-        "400":
-          description: Bad Request — file not found at the given path.
+        "404":
+          description: Not Found — file not found at the given path.
           content:
             application/json:
               schema:

intro/authentication.md

@@ -1,7 +1,7 @@
 ---
 title: Authentication
 excerpt: Learn to master the authentication flows of SeaTable.
-category: 6978dfd7217b10efe565eee6
+category: 69d4dc0c1422831f8d6fbb86
 isReference: true
 slug: authentication
 ---

intro/changelog.md

@@ -1,7 +1,7 @@
 ---
 title: Changelog
 excerpt: This page lists changes made to the Web API and its documentation.
-category: 6978dfd7217b10efe565eee6
+category: 69d4dc0c1422831f8d6fbb86
 isReference: true
 slug: changelog
 ---

intro/errors.md

@@ -1,7 +1,7 @@
 ---
 title: Status Codes
 excerpt: The HTTP response codes indicate success or error.
-category: 6978dfd7217b10efe565eee6
+category: 69d4dc0c1422831f8d6fbb86
 isReference: true
 slug: errors
 ---

intro/help.md

@@ -1,7 +1,7 @@
 ---
 title: Help & Support
 excerpt: Have you found a bug or need help? Here you can get it.
-category: 6978dfd7217b10efe565eee6
+category: 69d4dc0c1422831f8d6fbb86
 isReference: true
 slug: help
 ---

intro/introduction.md

@@ -1,7 +1,7 @@
 ---
 title: Introduction
 excerpt: This is the reference for the SeaTable API. On this page you will find everything you need to know to use SeaTable's API.
-category: 6978dfd7217b10efe565eee6
+category: 69d4dc0c1422831f8d6fbb86
 isReference: true
 slug: introduction
 ---

intro/limits.md

@@ -1,7 +1,7 @@
 ---
 title: Limits
 excerpt: Get an overview of all rate and size limits of the SeaTable API.
-category: 6978dfd7217b10efe565eee6
+category: 69d4dc0c1422831f8d6fbb86
 isReference: true
 slug: limits
 ---

intro/models.md

@@ -1,7 +1,7 @@
 ---
 title: Models
 excerpt: This page describes the different objects used in SeaTable.
-category: 6978dfd7217b10efe565eee6
+category: 69d4dc0c1422831f8d6fbb86
 isReference: true
 slug: models
 ---

intro/requirement-self-hosted.md

@@ -1,7 +1,7 @@
 ---
 title: Try It! with your own Server
 excerpt: Prerequisites to use api.seatable.com with your own self-hosted SeaTable server.
-category: 6978dfd7217b10efe565eee6
+category: 69d4dc0c1422831f8d6fbb86
 isReference: true
 slug: requirement-self-hosted
 ---

ping_and_info.yaml

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

python-scheduler.yaml

@@ -3,7 +3,7 @@ info:
   title: Python Scheduler
   description: >-
     The official SeaTable API Reference (OpenAPI 3.0).
-  version: "6.1"
+  version: "6.2"
 servers:
   - url: "https://{server}"
     variables:

system_admin_account_operations.yaml

@@ -3,7 +3,7 @@ info:
   title: "Account Operations: System admin"
   description: >-
     The official SeaTable API Reference (OpenAPI 3.0).
-  version: "6.1"
+  version: "6.2"
 servers:
   - url: "https://{server}"
     variables:
@@ -2620,7 +2620,11 @@ paths:
         "200":
           description: OK
           content:
-            # Actually application/x-zip-compressed, but dtable-web does not accept this in Accept header
+            # Response body is actually "application/x-zip-compressed", but dtable-web still returns
+            # 406 "Could not satisfy the request Accept header" when that value is sent in the "Accept"
+            # header on this admin endpoint (only */* or application/json work). Keep the workaround
+            # until the backend is fixed; regression is tracked by the xfail test
+            # tests/test_export.py::test_adminExportBase_accepts_zip_content_type.
             application/json: {}
 
   # Common Dataset