Skip to content

Commit

Permalink
[Documentation] Initial api documentation (#464)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexjustesen authored Mar 9, 2023
1 parent dc456ff commit dcc042c
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

![Dashboard](.github/screenshots/dashboard_screenshot.png)
Expand Down
62 changes: 62 additions & 0 deletions 🐇 Speedtest Tracker.postman_collection.json
Original file line number Diff line number Diff line change
@@ -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"
}
]
}

0 comments on commit dcc042c

Please sign in to comment.