mirror of
https://github.com/bdnugget/speedtest-tracker.git
synced 2026-11-07 08:37:27 +00:00
[Documentation] Initial api documentation (#464)
This commit is contained in:
1 parent
dc456ff431
commit
dcc042c4fb
2 files changed
+66
No files matched your search
@@ -20,6 +20,10 @@ Speedtest Tracker is containerized so you can run it anywhere you run your Docke
|
||||
|
||||
[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).
|
||||
|
||||
## API
|
||||
|
||||
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).
|
||||
|
||||
## Screenshots
|
||||
|
||||

|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
{
|
||||
"info": {
|
||||
"_postman_id": "cec84a4a-2422-4c13-bc49-3a2ee2729f62",
|
||||
"name": "🐇 Speedtest Tracker",
|
||||
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
|
||||
"_exporter_id": "13492307"
|
||||
},
|
||||
"item": [
|
||||
{
|
||||
"name": "Speedtest (legacy)",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get latest",
|
||||
"request": {
|
||||
"method": "GET",
|
||||
"header": [],
|
||||
"url": {
|
||||
"raw": "{{APP_URL}}/api/speedtest/latest",
|
||||
"host": [
|
||||
"{{APP_URL}}"
|
||||
],
|
||||
"path": [
|
||||
"api",
|
||||
"speedtest",
|
||||
"latest"
|
||||
]
|
||||
}
|
||||
},
|
||||
"response": []
|
||||
}
|
||||
],
|
||||
"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."
|
||||
}
|
||||
],
|
||||
"event": [
|
||||
{
|
||||
"listen": "prerequest",
|
||||
"script": {
|
||||
"type": "text/javascript",
|
||||
"exec": [
|
||||
""
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"listen": "test",
|
||||
"script": {
|
||||
"type": "text/javascript",
|
||||
"exec": [
|
||||
""
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"variable": [
|
||||
{
|
||||
"key": "APP_URL",
|
||||
"value": "",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in new issue
Block a user