Merge branch 'v5.3' into v5.2

Author: christophdb

.github/workflows/rdme-openapi.yml

@@ -74,12 +74,6 @@ jobs:
         with:
           rdme: openapi base_operations.yaml --key=${{ secrets.README_API_KEY }} --id=67812a09e88eab0a89818909 --useSpecVersion
 
-      # base operations (before 4.4)
-      - name: Update base operations 🚀
-        uses: readmeio/rdme@v8
-        with:
-          rdme: openapi base_operations_deprecated.yaml --key=${{ secrets.README_API_KEY }} --id=67812a09e88eab0a89818902 --useSpecVersion
-
       # file operations
       - name: Update file operations 🚀
         uses: readmeio/rdme@v8

README.md

@@ -4,7 +4,7 @@ Welcome to the SeaTable OpenAPI Definition Repository! 🌊🔍✨
 
 This repository encompasses all supported API calls for the SeaTable Server. The OpenAPI definition here serves two primary purposes:
 
-1. Generate the online API reference accessible at https://api.seatable.io.
+1. Generate the online API reference accessible at https://api.seatable.com.
 2. Generate the Postman collection, which is available at https://www.postman.com/seatable.
 
 The repository is organized into version branches.

authentication.yaml

@@ -54,7 +54,7 @@ components:
     workspace_id:
       name: workspace_id
       description: |
-        The id of the workspace. For an explanation how to get the *workspace_id*, check out this [help-article](https://seatable.io/docs/arbeiten-mit-gruppen/workspace-id-einer-gruppe-ermitteln/?lang=auto). 
+        The id of the workspace. For an explanation how to get the *workspace_id*, check out this [help-article](https://seatable.com/help/workspace-id-einer-gruppe-ermitteln/). 
         Alternatively the API endpoint [get metadata](/reference/getmetadata) can be used.
       in: path
       schema:

base_operations.yaml

@@ -2542,7 +2542,7 @@ paths:
         > 
         > New rows (INSERT statement) are always added to the **big data backend**. An error message will be returned, if the big data backend is not activated for the target base.
 
-        The complete [SQL Reference](https://developer.seatable.io/scripts/sql/reference/) can be found documentation in the developer manual. 
+        The complete [SQL Reference](https://developer.seatable.com/scripts/sql/reference/) can be found documentation in the developer manual. 
 
         Here are some example requests for a fictitious table *Family* with the columns *name*, *age* and *birthday*:
 
@@ -2562,6 +2562,10 @@ paths:
         >
         > - The request returns a maximum of 10 000 rows, even if you specify a higher limit in your SQL-statement. 
         > - If you don't specify a limit, max 100 rows are returned.
+
+        > 📘 Link Columns
+        >
+        > Link columns return a maximum of 50 records per row.
       requestBody:
         content:
           application/json:
@@ -2602,7 +2606,7 @@ paths:
 
         > 📘 Link Columns
         >
-        > Before version 5.3, the link column of a row returns a maximum of 10 records. From version 5.3 onward, it returns a maximum of 50 records.
+        > From version 5.3 onward, the link column of a row returns a maximum of 50 records.
 
       security:
         - BaseTokenAuth: []
@@ -3522,7 +3526,7 @@ paths:
 
         `new_column_type` is the new type of the target column. For a list of
         column type params refer to the SeaTable API Parameter.
-        For further information on column types, check the page [Models](https://api.seatable.io/reference/models).
+        For further information on column types, check the page [Models](https://api.seatable.com/reference/models).
       requestBody:
         content:
           application/json:
@@ -3600,7 +3604,7 @@ paths:
         For details, refer to the call [Insert Column](/reference/insertcolumn-1).
 
         Please note that you can't append `formula`, `link` or `link-formula` columns using this endpoint.
-        Use the [Insert Column](https://api.seatable.io/reference/insertcolumn-1) endpoint instead.
+        Use the [Insert Column](https://api.seatable.com/reference/insertcolumn-1) endpoint instead.
       requestBody:
         content:
           application/json:

base_operations_deprecated.yaml

@@ -2595,7 +2595,7 @@ paths:
         `SELECT name, age, birthday, gender FROM Participants`<br/>
         `SELECT name, surname FROM Participants ORDER BY name`<br/>
         `SELECT * FROM Participants LIMIT 25`
-        For more details, check the [SQL-syntax supported by SeaTable](https://developer.seatable.io/scripts/sql/reference/).
+        For more details, check the [SQL-syntax supported by SeaTable](https://developer.seatable.com/scripts/sql/reference/).
 
         > 📘 Returns also data from the big data backend
         > 
@@ -3811,7 +3811,7 @@ paths:
         `new_column_type` is the new type of the target column. For a list of
         column type params refer to the SeaTable API Parameter.
 
-        Get more information about columns and column types in [Models](https://api.seatable.io/reference/models).
+        Get more information about columns and column types in [Models](https://api.seatable.com/reference/models).
       requestBody:
         content:
           application/json:
@@ -3891,7 +3891,7 @@ paths:
         For details, refer to the call [Insert Column](/reference/insertcolumndeprecated).
 
         Please note that you can't append `formula`, `link` or `link-formula` columns using this endpoint.
-        Use the [Insert Column](https://api.seatable.io/reference/insertcolumndeprecated) endpoint instead.
+        Use the [Insert Column](https://api.seatable.com/reference/insertcolumndeprecated) endpoint instead.
       requestBody:
         content:
           application/json:

custom-domain/README.md

@@ -8,7 +8,7 @@ The following setup allows to reach api documentation via custom subdomain. A ng
 - MAIN URL: https://seatable.io
 - Robots.txt: [x] Indexing by robots is allowed
 - SITEMAP: [ ] The sitemap.xml is disabled
-- CANONICAL URL: https://api.seatable.io
+- CANONICAL URL: https://api.seatable.com
 
 ## Server configuration
 
@@ -20,10 +20,10 @@ It is important to add any header in the nginx configuration, otherwise the goog
 ```bash
 server {
     listen 443 ssl;
-    server_name api.seatable.io;
+    server_name api.seatable.com;
 
-    ssl_certificate /etc/letsencrypt/live/api.seatable.io/fullchain.pem;
-    ssl_certificate_key /etc/letsencrypt/live/api.seatable.io/privkey.pem;
+    ssl_certificate /etc/letsencrypt/live/api.seatable.com/fullchain.pem;
+    ssl_certificate_key /etc/letsencrypt/live/api.seatable.com/privkey.pem;
     ssl_session_timeout 5m;
 
     ssl_protocols TLSv1.2;
@@ -46,20 +46,20 @@ server {
     }
 
     location /sitemap.xml {
-        root /var/www/api.seatable.io/;
+        root /var/www/api.seatable.com/;
         access_log off;
     }
 
     location /robots.txt {
-        root /var/www/api.seatable.io/;
+        root /var/www/api.seatable.com/;
         access_log off;
     }
 }
 ```
 
 ### robots.txt
 
-The `/var/www/api.seatable.io/robots.txt` looks like this:
+The `/var/www/api.seatable.com/robots.txt` looks like this:
 
 ```bash
 User-agent: *
@@ -68,21 +68,31 @@ Disallow: /edit/
 Disallow: /suggested-edits/
 Disallow: /login
 Disallow: /logout
+Disallow: /v9
+Disallow: /v8
+Disallow: /v7
+Disallow: /v6
+Disallow: /v5
+Disallow: /v4
+Disallow: /v3
+Disallow: /v2
+Disallow: /v1
 ```
 
 ### Cronjob to create a sitemap.xml
 
-The following script runs every day one via cronjob in the directory `/var/www/api.seatable.io` and generates a `sitemap.xml`.
+The following script runs every day one via cronjob in the directory `/var/www/api.seatable.com` and generates a `sitemap.xml`.
+The cronjob could be: `1 1 * * * /var/www/api.seatable.com/create-sitemap.sh`
 
 ```bash
 #!/bin/bash
 
-SOURCE_URL="https://api.seatable.io/reference/introduction"
-OUTPUT_FILE_NAME="sitemap.xml"
+SOURCE_URL="https://api.seatable.com/reference/introduction"
+OUTPUT_FILE_NAME="/var/www/api.seatable.com/sitemap.xml"
 
 echo "Generate a new sitemap for ${SOURCE_URL}"
 curl ${SOURCE_URL} | grep -o 'href="/reference/[^"]*">' | cut -c7- | rev | cut -c3- | rev > ./found_links.txt
-sort ./found_links.txt | uniq > found_links_cleaned.txt
+sort /tmp/found_links.txt | uniq > /tmp/found_links_cleaned.txt
 
 # Create the XML header
 echo '<?xml version="1.0" encoding="UTF-8"?>' > ${OUTPUT_FILE_NAME}
@@ -92,7 +102,7 @@ echo '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">' >> ${OUTPUT_
 while IFS= read -r line; do
     line=$(echo "$line" | sed 's/^\///')  # Remove leading /
     echo "  <url>" >> ${OUTPUT_FILE_NAME}
-    echo "    <loc>https://api.seatable.io/$line</loc>" >> ${OUTPUT_FILE_NAME}
+    echo "    <loc>https://api.seatable.com/$line</loc>" >> ${OUTPUT_FILE_NAME}
     echo "    <changefreq>daily</changefreq>" >> ${OUTPUT_FILE_NAME}
     echo "    <priority>0.3</priority>" >> ${OUTPUT_FILE_NAME}
     echo "  </url>" >> ${OUTPUT_FILE_NAME}
@@ -101,6 +111,6 @@ done < found_links_cleaned.txt
 # Close the XML
 echo '</urlset>' >> ${OUTPUT_FILE_NAME}
 
-rm ./found_links.txt
-rm ./found_links_cleaned.txt
+rm /tmp/found_links.txt
+rm /tmp/found_links_cleaned.txt
 ```

intro/authentication.md

@@ -84,4 +84,4 @@ Treat your tokens like passwords, so be sure to keep them secure! Do not share y
 
 Account-Operations differentiate between User, Team Admin and System Admin. These are the three possible roles a user can have within SeaTable. Each user always has the User permission. The Team Admin or System Admin role must also be assigned to a user, and Team Admins only exist if teams/organizations are enabled in SeaTable. This is the case with <https://cloud.seatable.io>, but is typically not the case with self-hosted SeaTable instances.
 
-More details on SeaTable's team/organization structure and admin management can be found at <https://seatable.io/docs/>.
+More details on SeaTable's team/organization structure and admin management can be found at <https://help.seatable.com>.

intro/changelog.md

@@ -12,13 +12,13 @@ slug: changelog
 }
 </style>
 
-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.io/docs/changelog) or check out the [SeaTable Blog](https://seatable.io/blog) for detailed release notes.
+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.io/blog) for detailed release notes.
 
 ## Version 5.2 (25.02.2025)
 
 > ❗ Important Update: API Endpoint Changes
 >
-> In version 5.2, the `/dtable-server` and `/dtable-db` endpoints will be deprecated and then removed in version 6.0. All functions will be transitioned to `/api-gateway` endpoints. Please update your custom integrations and scripts accordingly to ensure continued functionality. More information will be provided with the release notes of SeaTable version 5.2.
+> In version 5.2, the `/dtable-server` and `/dtable-db` endpoints will be deprecated and then removed in version 5.3. All functions will be transitioned to `/api-gateway` endpoints. Please update your custom integrations and scripts accordingly to ensure continued functionality. More information will be provided with the release notes of SeaTable version 5.2.
 
 > 📘 New requests
 >
@@ -36,7 +36,7 @@ Listed below are all the changes to the SeaTable API. Each date corresponds to a
 
 ## Version 5.1 (08.11.2024)
 
-[View API Documentation for v5.1](https://api.seatable.io/v5.1)
+[View API Documentation for v5.1](https://api.seatable.com/v5.1)
 
 > 📘 New requests
 >
@@ -53,7 +53,7 @@ Listed below are all the changes to the SeaTable API. Each date corresponds to a
 
 ## Version 5.0 (15.07.2024)
 
-The SeaTable API Reference for version 5.0 is no longer accessible here. However, you can find it on [Github](https://github.com/seatable/openapi/tree/v5.0).
+[View API Documentation for v5.0](https://api.seatable.com/v5.0)
 
 We recommend using the new `/api-gateway/` endpoints. These endpoints are faster because they check if the base has remained unchanged since the last request, allowing for quicker responses.
 
@@ -68,7 +68,7 @@ We recommend using the new `/api-gateway/` endpoints. These endpoints are faster
 > - [List Rows](/reference/listrowsdeprecated): All column values are now consistently returned. If a value is not defined, `null` is returned instead of omitting the value.
 > - [Query SeaTable with SQL](/reference/querysql): Now supports `parameters` to protect against SQL injection.
 
-For more details about the changes, please refer to [this post on the SeaTable Forum](https://forum.seatable.io/t/important-changes-to-api-and-seatable-cloud-with-version-5-0/4887).
+For more details about the changes, please refer to [this post on the SeaTable Forum](https://forum.seatable.com/t/important-changes-to-api-and-seatable-cloud-with-version-5-0/4887).
 
 ## Version 4.4 (15.05.2024)
 

intro/help.md

@@ -14,7 +14,7 @@ slug: help
 
 ## Problems with an API request?
 
-We make every effort to keep this API documentation complete and error-free. If you still have a problem with one of the API requests, please open a ticket in our [support forum](https://forum.seatable.io).
+We make every effort to keep this API documentation complete and error-free. If you still have a problem with one of the API requests, please open a ticket in our [support forum](https://forum.seatable.com).
 
 In order to help you quickly, please add the following information in your ticket:
 
@@ -29,7 +29,7 @@ In order to help you quickly, please add the following information in your ticke
 
 ## Developer Manual
 
-Please have a look at the [SeaTable Developer Manual](https://developer.seatable.io). There you can find more information about custom API clients or code examples.
+Please have a look at the [SeaTable Developer Manual](https://developer.seatable.com). There you can find more information about custom API clients or code examples.
 
 ## Expert support