Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions .github/readme-ids.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"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"
"version": "7.0",
"authentication": "",
"base_operations": "",
"file_operations": "",
"system_admin_account_operations": "",
"team_admin_account_operations": "",
"user_account_operations": "",
"ping_and_info": "",
"python_scheduler": ""
}
14 changes: 9 additions & 5 deletions .github/workflows/api-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ on:
workflow_dispatch:
inputs:
version:
description: "SeaTable version (e.g. 6.1.8)"
description: "SeaTable version"
required: true
default: "6.1.8"
default: "7.0.7"
image:
description: "Docker Hub repository"
required: true
Expand All @@ -28,13 +28,14 @@ on:
- "seatable/seatable-enterprise-testing"

env:
DEFAULT_VERSION: "6.2.12"
DEFAULT_VERSION: "7.0.7"
DEFAULT_IMAGE: "seatable/seatable-enterprise-testing"
DTABLE_SERVER_VERSION: "7.0.7-testing"


jobs:
test:
runs-on: ubuntu-latest
runs-on: ubuntu-26.04
steps:
- name: Check out repo
uses: actions/checkout@v6
Expand Down Expand Up @@ -67,8 +68,11 @@ jobs:

- name: Start SeaTable ${{ steps.version.outputs.version }}
working-directory: version-compare
env:
SEATABLE_IMAGE: ${{ steps.version.outputs.image }}
SEATABLE_VERSION: ${{ steps.version.outputs.version }}
run: |
SEATABLE_IMAGE=${{ steps.version.outputs.image }} SEATABLE_VERSION=${{ steps.version.outputs.version }} docker compose up -d
docker compose up -d
./setup.sh

- name: Run API tests
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/postman.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ env:

jobs:
postman:
runs-on: ubuntu-latest
runs-on: ubuntu-26.04
steps:
- name: Checkout repository
uses: actions/checkout@v4
Expand Down
8 changes: 5 additions & 3 deletions .github/workflows/rdme-openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ jobs:
# Job 1: Publish OpenAPI specs and docs to ReadMe.com
# -----------------------------------------------------------------------
publish:
if: false # temporarily disabled
name: Publish to ReadMe
runs-on: ubuntu-latest
runs-on: ubuntu-26.04
steps:
- name: Check out repo
uses: actions/checkout@v4
Expand Down Expand Up @@ -175,8 +176,9 @@ jobs:
# -----------------------------------------------------------------------
deploy-static:
name: Deploy static files
if: github.ref_name == github.event.repository.default_branch
runs-on: ubuntu-latest
if: false # temporarily disabled
# if: github.ref_name == github.event.repository.default_branch
runs-on: ubuntu-26.04
needs: publish
steps:
- name: Check out repo
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/version-compare.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ on:

jobs:
compare:
runs-on: ubuntu-latest
runs-on: ubuntu-26.04
steps:
- name: Check out repo
uses: actions/checkout@v4
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,10 @@ cd version-compare
export SEATABLE_IMAGE=seatable/seatable-enterprise
export SEATABLE_VERSION=6.0.10

# seatable/dtable-server-js or seatable/dtable-server-go
export DTABLE_SERVER_IMAGE=seatable/dtable-server-js
export DTABLE_SERVER_VERSION=7.0.3-testing

# Create license file
cp "SOURCE" seatable-license.txt

Expand Down
2 changes: 1 addition & 1 deletion authentication.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ info:
title: Authentication
description: >-
The official SeaTable API Reference (OpenAPI 3.0).
version: "6.2"
version: "7.0"
servers:
- url: "https://{server}"
variables:
Expand Down
2 changes: 1 addition & 1 deletion base_operations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ info:
title: Base Operations
description: >-
The official SeaTable API Reference (OpenAPI 3.0).
version: "6.2"
version: "7.0"
servers:
- url: "https://{server}"
variables:
Expand Down
2 changes: 1 addition & 1 deletion file_operations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ info:
title: File Operations
description: >-
The official SeaTable API Reference (OpenAPI 3.0).
version: "6.2"
version: "7.0"
servers:
- url: "https://{server}"
variables:
Expand Down
10 changes: 10 additions & 0 deletions intro/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,16 @@ slug: changelog

Listed below are all the changes to the SeaTable API. Each date corresponds to a new version of SeaTable Server Enterprise Edition. If you’re looking for changes beyond the API, see the SeaTable [Changelog](https://seatable.com/changelog) or check out the [SeaTable Blog](https://seatable.com/blog) for detailed release notes.

## Version 7.0

> 📘 New requests
>
> **Account Operations - Team Admin**
>
> - [List Managed Apps](/reference/listmanagedapps) <span class="APIMethod APIMethod_fixedWidth APIMethod_get">get</span>
> - [List Usable Apps](/reference/listusableapps) <span class="APIMethod APIMethod_fixedWidth APIMethod_get">get</span>
> - [List Bases Shared to User](/reference/listbasessharedtouser-1) <span class="APIMethod APIMethod_fixedWidth APIMethod_get">get</span>

## Version 6.2 (21.07.2026)

> 🚧 Breaking changes
Expand Down
15 changes: 12 additions & 3 deletions ping_and_info.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.2"
version: "7.0"
servers:
- url: "https://{server}"
variables:
Expand Down Expand Up @@ -115,10 +115,14 @@ paths:
- Ping
summary: Ping dtable Server
operationId: pingDtableServer
description: >-
description: |-
Check the status of the dtable-server. Base related operations are
carried out by the dtable-server. These operations are included in the
section **Base Operations**.

> 🚧 Not exposed by default
>
> As of SeaTable 7.0, the default NGINX configuration no longer routes `/dtable-server/` and this endpoint returns `404`.
responses:
"200":
description: Service is available and running
Expand All @@ -134,7 +138,12 @@ paths:
- Ping
summary: Ping dtable-db Server
operationId: pingDtableDbServer
description: Check the status of the dtable-db server.
description: |-
Check the status of the dtable-db server.

> 🚧 Not exposed by default
>
> As of SeaTable 7.0, the default NGINX configuration no longer routes `/dtable-db/` and this endpoint returns `404`.
responses:
"200":
description: Service is available and running
Expand Down
2 changes: 1 addition & 1 deletion python-scheduler.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ info:
title: Python Scheduler
description: >-
The official SeaTable API Reference (OpenAPI 3.0).
version: "6.2"
version: "7.0"
servers:
- url: "https://{server}"
variables:
Expand Down
2 changes: 1 addition & 1 deletion system_admin_account_operations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ info:
title: "Account Operations: System admin"
description: >-
The official SeaTable API Reference (OpenAPI 3.0).
version: "6.2"
version: "7.0"
servers:
- url: "https://{server}"
variables:
Expand Down
127 changes: 126 additions & 1 deletion team_admin_account_operations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ info:
title: Account Operations - Team admin
description: >-
The official SeaTable API Reference (OpenAPI 3.0).
version: "6.2"
version: "7.0"
servers:
- url: "https://{server}"
variables:
Expand Down Expand Up @@ -451,6 +451,7 @@ paths:
type: string
last_login:
type: string
nullable: true
self_usage:
type: integer
quota:
Expand Down Expand Up @@ -715,6 +716,88 @@ paths:
example:
success: true

/api/v2.1/org/{org_id}/admin/users/{user_id}/managed-external-apps/:
get:
tags:
- Users
summary: List Managed Apps
operationId: listManagedApps
description: >-
List all the universal apps a certain user manages, i.e. the apps in
which the user has the `admin` role. Inactive apps and apps of deleted
bases are not included.
security:
- AccountTokenAuth: []
parameters:
- $ref: "#/components/parameters/org_id"
- $ref: "#/components/parameters/user_id"
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/per_page"
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
example:
managed_apps:
- app_user_id: 12
app_id: 4
app_name: Customer Portal
app_uuid: 25ed3722-7988-4389-8095-9a46373cd8a5
app_config: '{"app_type": "universal-app", "app_name": "Customer Portal", "settings": {"pages": [], "navigation": []}}'
role_name: admin
permission: rw
dtable_uuid: c56624fd757f4f4bae7de76235aeb1f0
dtable_name: CRM
workspace_id: 2
link: https://cloud.seatable.io/external-apps/25ed3722-7988-4389-8095-9a46373cd8a5/
edit_link: https://cloud.seatable.io/dtable/external-apps-edit/25ed3722-7988-4389-8095-9a46373cd8a5/
joined_at: '2025-11-28T14:16:30+01:00'
count: 1

/api/v2.1/org/{org_id}/admin/users/{user_id}/can-use-external-apps/:
get:
tags:
- Users
summary: List Usable Apps
operationId: listUsableApps
Comment on lines +764 to +765

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Naming?

description: >-
List all the universal apps a certain user can use, i.e. the apps in
which the user has a role other than `admin`. Inactive apps and apps
of deleted bases are not included.
security:
- AccountTokenAuth: []
parameters:
- $ref: "#/components/parameters/org_id"
- $ref: "#/components/parameters/user_id"
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/per_page"
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
example:
can_use_apps:
- app_user_id: 13
app_id: 4
app_name: Customer Portal
app_uuid: 25ed3722-7988-4389-8095-9a46373cd8a5
app_config: '{"app_type": "universal-app", "app_name": "Customer Portal", "settings": {"pages": [], "navigation": []}}'
role_name: default
permission: rw
dtable_uuid: c56624fd757f4f4bae7de76235aeb1f0

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the API instead return this in a hyphenated form? Most of the other endpoints do, but apparently there are some exceptions:

  • listApps
  • changeAppStatus

dtable_name: CRM
workspace_id: 2
link: https://cloud.seatable.io/external-apps/25ed3722-7988-4389-8095-9a46373cd8a5/
edit_link: https://cloud.seatable.io/dtable/external-apps-edit/25ed3722-7988-4389-8095-9a46373cd8a5/
joined_at: '2025-11-28T14:16:30+01:00'
count: 1

# Bases
/api/v2.1/org/{org_id}/admin/dtables/:
get:
Expand Down Expand Up @@ -837,6 +920,48 @@ paths:
owner_deleted: false
rows_count: 0
count: 2
/api/v2.1/org/{org_id}/admin/users/{user_id}/shared-dtables/:
get:
tags:
- Bases
summary: List Bases Shared to User
operationId: listBasesSharedToUser
description: List all the bases shared to a certain user by the user's ID.
security:
- AccountTokenAuth: []
parameters:
- $ref: "#/components/parameters/org_id"
- $ref: "#/components/parameters/user_id"
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/per_page"
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
example:
dtable_list:
- id: 8
workspace_id: 2
uuid: 3a6e34b7-c9e1-4c2f-8b0e-2f5d3f21c7a4
name: CRM
created_at: '2025-11-28T14:16:30+01:00'
updated_at: '2025-11-28T14:17:04+01:00'
color: "#E91E63"
text_color: null
icon: icon-user-interview
is_encrypted: false
in_storage: true
backend: js
creator: org-1-admin
modifier: org-1-admin
file_size: 1389
rows_count: 7
from_user: e38487b4357e40c8b1359223ba87a1af@auth.local
from_user_name: org-1-admin
count: 1
/api/v2.1/org/{org_id}/admin/dtables/{base_uuid}/:
get:
tags:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,16 @@
"archived_row_count": "int",
"dtable_server_info": [
{
"assigned_keys_count": 0,
"backend": "",
"enable_cluster": false,
"last_dtable_saving_count": "int",
"last_period_operations_count": "int",
"loaded_dtables_count": "int",
"local_node_url": "http://dtable-server:5000",
"node_id": "",
"operation_count_since_up": "int",
"start_time": "",
"web_socket_count": "int"
}
],
Expand Down
Loading