Browse Source

Quick manifest endpoint

pjc 4 years ago
parent
commit
94d21ed45d
2 changed files with 50 additions and 1 deletions
  1. 35
    0
      docs/meta.md
  2. 15
    1
      docs/users.md

+ 35
- 0
docs/meta.md View File

76
 ```
76
 ```
77
 
77
 
78
 
78
 
79
+## Manifest
80
+
81
+Fetch an app manifest.
82
+
83
+
84
+**Request**
85
+
86
+`ajax.php?action=manifest`
87
+
88
+
89
+**Response**
90
+
91
+```json
92
+{
93
+    "status": "success",
94
+    "response": {
95
+        "name": "BioTorrents.de",
96
+        "short_name": "BioTorrents.de",
97
+        "description": "A platform to share biological sequence and medical imaging data",
98
+        "start_url": "index.php",
99
+        "display": "standalone",
100
+        "background_color": "#ffffff",
101
+        "theme_color": "#0288d1",
102
+        "icons": [
103
+            {
104
+                "src": "/static/common/icon.png",
105
+                "sizes": "120x120",
106
+                "type": "image/png"
107
+            }
108
+        ]
109
+    }
110
+}
111
+```
112
+
113
+
79
 ## Load average
114
 ## Load average
80
 
115
 
81
 Requires moderator permissions to access without error.
116
 Requires moderator permissions to access without error.

+ 15
- 1
docs/users.md View File

442
 
442
 
443
 ## Notifications
443
 ## Notifications
444
 
444
 
445
+Fetch new upload filter notifications.
446
+
447
+
445
 **Request**
448
 **Request**
446
 
449
 
447
 `ajax.php?action=notifications`
450
 `ajax.php?action=notifications`
466
 **Response**
469
 **Response**
467
 
470
 
468
 ```json
471
 ```json
469
-
472
+{
473
+    "status": "success",
474
+    "response": {
475
+        "Global": {
476
+            "id": 0,
477
+            "message": "Global Notification",
478
+            "url": "https://docs.biotorrents.de",
479
+            "importance": "information"
480
+        },
481
+        # etc.
482
+    }
483
+}
470
 ```
484
 ```
471
 
485
 
472
 
486
 

Loading…
Cancel
Save