Various small updates

docs/index.md

@@ -59,8 +59,10 @@ Please get it touch if you'd like me to list your project below.
 
 ## Rate limit
 
-The API is rate-limited to one request every ten seconds.
+The API is rate-limited to one request every 12 seconds.
 This limit doesn't apply to users in the Donor class.
+[Please consider donating](https://www.patreon.com/biotorrents)
+to support this scientific resource's development.
 
 
 ## Under construction

docs/requests.md

@@ -1,141 +0,0 @@
-# Requests
-
-Endpoints related to torrent requests.
-
-
-## Request
-
-**Request**
-
-`ajax.php?action=request`
-
-`&id=` — request id (required)
-
-`&page=` — page of the comments to display (default: last page)
-
-
-**Response**
-
-```json
-{
-    "status": "success",
-    "response": {
-        "requestId": 2,
-        "requestorId": 2,
-        "requestorName": "me",
-        "isBookmarked": false,
-        "requestTax": 0.1,
-        "timeAdded": "2020-04-23 02:02:37",
-        "canEdit": true,
-        "canVote": true,
-        "minimumVote": 20971520,
-        "voteCount": 1,
-        "lastVote": "2020-11-15 06:51:56",
-        "topContributors": [
-            {
-                "userId": 2,
-                "userName": "me",
-                "bounty": 15461882266
-            }
-        ],
-        "totalBounty": 15461882266,
-        "categoryId": 10,
-        "categoryName": "Models",
-        "title": "Markov State Model Database of Protein Folding Datasets",
-        "year": 0,
-        "image": "",
-        "bbDescription": "BBcode",
-        "description": "HTML",
-        "artists": [
-            {
-                "id": 88,
-                "name": "Thomas Lane"
-            }
-        ],
-        "isFilled": false,
-        "fillerId": 0,
-        "fillerName": "",
-        "torrentId": 0,
-        "timeFilled": "",
-        "tags": [
-            "coding",
-            "proteomics",
-            "biochemistry",
-            "data.science",
-            "gene.expression"
-        ],
-        "comments": [],
-        "commentPage": 1,
-        "commentPages": 0
-    }
-}
-```
-
-
-## Search
-
-If no arguments are specified then the most recent requests are shown.
-
-
-**Request**
-
-`ajax.php?action=requests`
-
-`&page=` — page to display (default: `1`)
-
-`&search=` — search term
-
-`&show_filled=` — include filled requests in results `true` or `false` (default: `false`)
-
-`&tag=` — tags to search by (comma separated)
-
-`&tags_type=` — `0` for any, `1` for match all
-
-`filter_cat[]`, `releases[]`, `bitrates[]`, `formats[]`, `media[]` — as used on requests.php
-
-
-**Response**
-
-```json
-{
-    "status": "success",
-    "response": {
-        "currentPage": 1,
-        "pages": 1,
-        "results": [
-            {
-                "requestId": 3,
-                "requestorId": 2,
-                "requestorName": "me",
-                "timeAdded": "2020-11-15 06:49:10",
-                "lastVote": "2020-11-15 06:49:27",
-                "voteCount": 1,
-                "bounty": 7825312768,
-                "categoryId": 8,
-                "categoryName": "Images",
-                "authors": [
-                    {
-                        "id": 148,
-                        "name": "Oliver Batchelor"
-                    }
-                ],
-                "title": "trees.tar.gz",
-                "year": 0,
-                "picture": "",
-                "description": "BBcode",
-                "isFilled": false,
-                "fillerId": 0,
-                "fillerName": "",
-                "torrentId": 0,
-                "timeFilled": ""
-            },
-            {
-                "requestId": 2,
-                "requestorId": 2,
-                # etc.
-            },
-            # etc.
-        ]
-    }
-}
-```

docs/torrents.md

@@ -252,6 +252,7 @@ The advanced search options are certain to change in the future.
 }
 ```
 
+
 ## Comments 
 
 Fetch comments from torrent pages.
@@ -290,7 +291,8 @@ Fetch comments from torrent pages.
                     "avatar": "https://i.imgur.com/OdSSWrw.png",
                     "enabled": true,
                     "userTitle": null
-                }
+                },
+                # etc.
             }
         ]
     }
@@ -298,6 +300,10 @@ Fetch comments from torrent pages.
 ```
 
 
+# Torrent features
+
+Various features around the torrents themselves.
+
 ## Collage
 
 **Request**
@@ -414,6 +420,144 @@ Please see the response below for details.
 ```
 
 
+## Request
+
+**Request**
+
+`ajax.php?action=request`
+
+`&id=` — request id (required)
+
+`&page=` — page of the comments to display (default: last page)
+
+
+**Response**
+
+```json
+{
+    "status": "success",
+    "response": {
+        "requestId": 2,
+        "requestorId": 2,
+        "requestorName": "me",
+        "isBookmarked": false,
+        "requestTax": 0.1,
+        "timeAdded": "2020-04-23 02:02:37",
+        "canEdit": true,
+        "canVote": true,
+        "minimumVote": 20971520,
+        "voteCount": 1,
+        "lastVote": "2020-11-15 06:51:56",
+        "topContributors": [
+            {
+                "userId": 2,
+                "userName": "me",
+                "bounty": 15461882266
+            }
+        ],
+        "totalBounty": 15461882266,
+        "categoryId": 10,
+        "categoryName": "Models",
+        "title": "Markov State Model Database of Protein Folding Datasets",
+        "year": 0,
+        "image": "",
+        "bbDescription": "BBcode",
+        "description": "HTML",
+        "artists": [
+            {
+                "id": 88,
+                "name": "Thomas Lane"
+            }
+        ],
+        "isFilled": false,
+        "fillerId": 0,
+        "fillerName": "",
+        "torrentId": 0,
+        "timeFilled": "",
+        "tags": [
+            "coding",
+            "proteomics",
+            "biochemistry",
+            "data.science",
+            "gene.expression"
+        ],
+        "comments": [],
+        "commentPage": 1,
+        "commentPages": 0
+    }
+}
+```
+
+
+## Request search
+
+If no arguments are specified then the most recent requests are shown.
+
+
+**Request**
+
+`ajax.php?action=requests`
+
+`&page=` — page to display (default: `1`)
+
+`&search=` — search term
+
+`&show_filled=` — include filled requests in results `true` or `false` (default: `false`)
+
+`&tag=` — tags to search by (comma separated)
+
+`&tags_type=` — `0` for any, `1` for match all
+
+`filter_cat[]`, `releases[]`, `bitrates[]`, `formats[]`, `media[]` — as used on requests.php
+
+
+**Response**
+
+```json
+{
+    "status": "success",
+    "response": {
+        "currentPage": 1,
+        "pages": 1,
+        "results": [
+            {
+                "requestId": 3,
+                "requestorId": 2,
+                "requestorName": "me",
+                "timeAdded": "2020-11-15 06:49:10",
+                "lastVote": "2020-11-15 06:49:27",
+                "voteCount": 1,
+                "bounty": 7825312768,
+                "categoryId": 8,
+                "categoryName": "Images",
+                "authors": [
+                    {
+                        "id": 148,
+                        "name": "Oliver Batchelor"
+                    }
+                ],
+                "title": "trees.tar.gz",
+                "year": 0,
+                "picture": "",
+                "description": "BBcode",
+                "isFilled": false,
+                "fillerId": 0,
+                "fillerName": "",
+                "torrentId": 0,
+                "timeFilled": ""
+            },
+            {
+                "requestId": 2,
+                "requestorId": 2,
+                # etc.
+            },
+            # etc.
+        ]
+    }
+}
+```
+
+
 ## Top 10
 
 Fetch the Top 10 torrents, tags, or users.

docs/users.md

@@ -491,8 +491,20 @@ Fetch bookmarked torrents or artists.
 
 **Response**
 
-```json
+```php
+# Currently no proper status response.
+# Please see the code snippet below:
+
+switch ($Type) {
+  case NotificationsManager::INBOX:
+    NotificationsManager::clear_inbox();
+    break;
+
+  case NotificationsManager::NEWS:
+    NotificationsManager::clear_news(false);
+    break;
 
+  # etc.
 ```