-
Notifications
You must be signed in to change notification settings - Fork 3
Document new dtable-web endpoints
#85
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
simonhammes
wants to merge
7
commits into
v7.0
Choose a base branch
from
document-new-dtable-web-endpoints
base: v7.0
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
7fb5b66
Initialize v7.0
simonhammes c21fe95
Remove init-databases.sql mount
simonhammes 6bc01b8
Deploy dtable-server container
simonhammes 0c641e0
Bump version to v7.0.6
simonhammes a556385
Bump image tags to 7.0.7
simonhammes d7be79f
Document new dtable-web endpoints
simonhammes 362b39e
API returns last_login = null when creating a user
simonhammes File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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": "" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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: | ||
|
|
@@ -451,6 +451,7 @@ paths: | |
| type: string | ||
| last_login: | ||
| type: string | ||
| nullable: true | ||
| self_usage: | ||
| type: integer | ||
| quota: | ||
|
|
@@ -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 | ||
| 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 | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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:
|
||
| 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: | ||
|
|
@@ -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: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Naming?