Skip to content

Commit dcc042c

Browse files
authored
[Documentation] Initial api documentation (alexjustesen#464)
1 parent dc456ff commit dcc042c

File tree

2 files changed

+66
-0
lines changed

2 files changed

+66
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ Speedtest Tracker is containerized so you can run it anywhere you run your Docke
2020

2121
[FAQs](https://docs.speedtest-tracker.dev/faqs) and a full list of planned and completed [features](https://docs.speedtest-tracker.dev/getting-started/features) can be found in the [documentation](https://docs.speedtest-tracker.dev).
2222

23+
## API
24+
25+
A robust API is planned for a later release but `v0.11.8` includes a legacy endpoint `/api/speedtest/latest` which is used by home lab dashboards like [Homepage](https://github.com/benphelps/homepage) and [Organizr](https://github.com/causefx/Organizr/tree/v2-master).
26+
2327
## Screenshots
2428

2529
![Dashboard](.github/screenshots/dashboard_screenshot.png)
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
{
2+
"info": {
3+
"_postman_id": "cec84a4a-2422-4c13-bc49-3a2ee2729f62",
4+
"name": "🐇 Speedtest Tracker",
5+
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
6+
"_exporter_id": "13492307"
7+
},
8+
"item": [
9+
{
10+
"name": "Speedtest (legacy)",
11+
"item": [
12+
{
13+
"name": "Get latest",
14+
"request": {
15+
"method": "GET",
16+
"header": [],
17+
"url": {
18+
"raw": "{{APP_URL}}/api/speedtest/latest",
19+
"host": [
20+
"{{APP_URL}}"
21+
],
22+
"path": [
23+
"api",
24+
"speedtest",
25+
"latest"
26+
]
27+
}
28+
},
29+
"response": []
30+
}
31+
],
32+
"description": "The `/speedtest` route is to provide legacy support for dashboards like Homepage and Organizr.\n\nThe endpoint should be considered deprecated and will be replaced in a future release."
33+
}
34+
],
35+
"event": [
36+
{
37+
"listen": "prerequest",
38+
"script": {
39+
"type": "text/javascript",
40+
"exec": [
41+
""
42+
]
43+
}
44+
},
45+
{
46+
"listen": "test",
47+
"script": {
48+
"type": "text/javascript",
49+
"exec": [
50+
""
51+
]
52+
}
53+
}
54+
],
55+
"variable": [
56+
{
57+
"key": "APP_URL",
58+
"value": "",
59+
"type": "string"
60+
}
61+
]
62+
}

0 commit comments

Comments
 (0)