fix broken links

Author: christophdb

.gitignore

@@ -5,4 +5,5 @@
 /tests/diff*
 /tests/.hypothesis
 /tests/__pycache__
-.vscode
+.vscode
+result-*.txt

README.md

@@ -98,4 +98,9 @@ git push --tags
 ```
 
 Pushing the tag triggers a GitHub Action that runs the `sync-with-postman.sh` script.
-This action requires the GitHub secret `POSTMAN_API_KEY`, which you can generate at: https://seatable.postman.co/settings/me/api-keys.
+This action requires the GitHub secret `POSTMAN_API_KEY`, which you can generate at: https://seatable.postman.co/settings/me/api-keys.
+
+## Check for Invalid Links
+
+Run `./check-links.sh` to validate all links in this OpenAPI documentation.
+This script generates a `result-YYYY-MM-DD.txt` file listing all valid and invalid links. Search this file for **404** errors or other issues and fix them accordingly.

base_operations.yaml

@@ -2440,7 +2440,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.com/scripts/sql/reference/) can be found documentation in the developer manual. 
+        The complete [SQL Reference](https://developer.seatable.com/scripts/sql/functions/) 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*:
 

check-links.sh

@@ -1,8 +1,12 @@
 #!/bin/bash
 
 echo "Extracting links into /tmp/seatable-openapi-links.txt"
-grep -oP --no-filename '\]\(\K[^\)]+(?=\))' intro/*.md ./*.yaml | awk '/^\// {print "https://api.seatable.io" $0; next} {print}' > /tmp/seatable-openapi-links.txt
-COUNT=$(wc -l < /tmp/seatable-openapi.links.txt)
+grep -oP --no-filename '\]\(\K[^\)]+(?=\))' intro/*.md ./*.yaml | awk '/^\// {print "https://api.seatable.com" $0; next} {print}' > /tmp/seatable-openapi-links.txt
+
+# clean unwanted urls:
+sed -i '/^https/!d' /tmp/seatable-openapi-links.txt
+
+COUNT=$(wc -l < /tmp/seatable-openapi-links.txt)
 echo -e "Found ${COUNT} links!\n"
 
 INPUT_FILE="/tmp/seatable-openapi-links.txt"

intro/changelog.md

@@ -57,8 +57,8 @@ Listed below are all the changes to the SeaTable API. Each date corresponds to a
 > **Account Operations - System Admin**
 >
 > - [List Virus Files](/reference/listvirusfiles) <span class="APIMethod APIMethod_fixedWidth APIMethod_get">get</span>
-> - [Update Virus Files](/reference/updatevirusfiles) <span class="APIMethod APIMethod_fixedWidth APIMethod_put">put</span>
-> - [Delete Virus Files](/reference/deletevirusfiles) <span class="APIMethod APIMethod_fixedWidth APIMethod_delete">delete</span>
+> - [Update Virus Files](/reference/updatevirusfile) <span class="APIMethod APIMethod_fixedWidth APIMethod_put">put</span>
+> - [Delete Virus Files](/reference/deletevirusfile) <span class="APIMethod APIMethod_fixedWidth APIMethod_delete">delete</span>
 
 ## Version 5.2 (25.02.2025)
 
@@ -107,13 +107,13 @@ We recommend using the new `/api-gateway/` endpoints. These endpoints are faster
 
 > 🚧 Breaking changes
 >
-> - [Get Row](/reference/getrowdeprecated) and [List Rows](/reference/listrowsdeprecated): `Link` now returns an array containing `display_value` and `row_id` instead of a string with only the `display_value`. This change harmonizes the output with `Get Row` and `List Rows with SQL` endpoints.
-> - [Get Row](/reference/getrowdeprecated) and [List Rows](/reference/listrowsdeprecated): `Link Formula` now returns the right output type depending of the result. Single numbers are returned as integers, multiple values as arrays. This change harmonizes the output of the `Get Row`, `List Rows` and `List Rows with SQL` endpoints.
+> - [Get Row](/reference/getrow) and [List Rows](/reference/listrows): `Link` now returns an array containing `display_value` and `row_id` instead of a string with only the `display_value`. This change harmonizes the output with `Get Row` and `List Rows with SQL` endpoints.
+> - [Get Row](/reference/getrow) and [List Rows](/reference/listrows): `Link Formula` now returns the right output type depending of the result. Single numbers are returned as integers, multiple values as arrays. This change harmonizes the output of the `Get Row`, `List Rows` and `List Rows with SQL` endpoints.
 
 > 👍 Other changes
 >
-> - [Get Row](/reference/getrowdeprecated): All column values are now consistently returned. If a value is not defined, `null` is returned instead of omitting the value.
-> - [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.
+> - [Get Row](/reference/getrow): All column values are now consistently returned. If a value is not defined, `null` is returned instead of omitting the value.
+> - [List Rows](/reference/listrows): 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.com/t/important-changes-to-api-and-seatable-cloud-with-version-5-0/4887).
@@ -131,11 +131,11 @@ The SeaTable API Reference for version 4.4 is no longer accessible here. However
 > 🚧 Breaking changes
 >
 > - data collection table calls (user) were removed. This was done because data collection tables will be disabled in general with version 5.0. In SeaTable Cloud this feature was never available.
-> - [Get Row](/reference/getrowdeprecated): `_mtime` and `_ctime` are not returned if these column types are defined in this base. This is to harmonize the output with `List Rows` and `List Rows with SQL`.
+> - [Get Row](/reference/getrow): `_mtime` and `_ctime` are not returned if these column types are defined in this base. This is to harmonize the output with `List Rows` and `List Rows with SQL`.
 
 > 👍 Other changes
 >
-> - [List Rows](/reference/listrowsdeprecated): The options `order_by` and `direction` were removed to avoid conflict situations with a selected view.
+> - [List Rows](/reference/listrows): The options `order_by` and `direction` were removed to avoid conflict situations with a selected view.
 > - API-Gateway calls now return the current api usage and limits via X-header.
 
 ## Version 4.3 (08.02.2024)
@@ -146,8 +146,8 @@ The SeaTable API Reference for version 4.3 is no longer accessible here. However
 >
 > **Base Operations**
 >
-> - [Create Row Links in Big Data](/reference/createbigdatarowslinkdeprecated) <span class="APIMethod APIMethod_fixedWidth APIMethod_post">post</span> `/dtable-db/api/v1/base/{base_uuid}/links/`
-> - [Delete Row Links in Big Data](/reference/deletebigdatarowlinksdeprecated) <span class="APIMethod APIMethod_fixedWidth APIMethod_delete">delete</span> `/dtable-db/api/v1/base/{base_uuid}/links/`
+> - **Create Row Links in Big Data** <span class="APIMethod APIMethod_fixedWidth APIMethod_post">post</span> `/dtable-db/api/v1/base/{base_uuid}/links/`
+> - **Delete Row Links in Big Data** <span class="APIMethod APIMethod_fixedWidth APIMethod_delete">delete</span> `/dtable-db/api/v1/base/{base_uuid}/links/`
 >
 > **Account Operations - System Admin**
 >

intro/introduction.md

@@ -189,7 +189,6 @@ To [update a row](https://api.seatable.com/reference/updaterow) you need to know
 
 - [List Rows (with SQL)](https://api.seatable.com/reference/querysql)
 - [List Rows](https://api.seatable.com/reference/listrows)
-- [Base Info](https://api.seatable.com/reference/getbaseinfo)
 
 #### Step 2: Update the row
 

intro/limits.md

@@ -84,5 +84,5 @@ Besides the rate limits, there are size limits for how many rows a **single call
 | [Insert, Update or Delete Rows (with SQL)](https://api.seatable.com/reference/querysql)<br/>`POST /api-gateway/api/v2/dtables/{...}/sql/` | unlimited           |
 | [List rows](https://api.seatable.com/reference/listrows)<br/>`GET /api-gateway/api/v2/dtables/{...}/rows/`                                | 1.000               |
 | [Append rows](https://api.seatable.com/reference/appendrows)<br/>`POST /api-gateway/api/v2/dtables/{...}/rows/`                           | 1.000               |
-| [Update rows](https://api.seatable.com/reference/updaterows)<br/>`PUT /api-gateway/api/v2/dtables/{...}/rows/`                            | 1.000               |
-| [Delete rows](https://api.seatable.com/reference/deleterows)<br/>`DELETE /api-gateway/api/v2/dtables/{base_uuid}/rows/`                   | 10.000              |
+| [Update rows](https://api.seatable.com/reference/updaterow)<br/>`PUT /api-gateway/api/v2/dtables/{...}/rows/`                            | 1.000               |
+| [Delete rows](https://api.seatable.com/reference/deleterow)<br/>`DELETE /api-gateway/api/v2/dtables/{base_uuid}/rows/`                   | 10.000              |