Skip to content

Commit 525f64f

Browse files
authored
Merge branch 'main' into main
2 parents 0adda60 + 43b0d47 commit 525f64f

File tree

3 files changed

+30
-2
lines changed

3 files changed

+30
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >-
88
# Introduction
99

1010
{% hint style="info" %}
11-
Docs are up-to-date through version: `v1.5.0`
11+
Docs are up-to-date through version: `v1.6.0`
1212
{% endhint %}
1313

1414
<figure><img src=".gitbook/assets/dashboard.png" alt=""><figcaption></figcaption></figure>

api/v1.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,26 @@ curl localhost/api/v1/results/latest
9696
9797
9898
99+
***
100+
101+
### Run speedtest
102+
103+
```bash
104+
curl -X POST localhost/api/v1/speedtests/run
105+
-H "Accept: application/json"
106+
-H "Authorization: Bearer yourtokengoeshere"
107+
```
108+
109+
#### Parameters
110+
111+
* `server_id` - Ookla server ID (optional)
112+
113+
#### Responses
114+
115+
* 201: Created
116+
* 403: Forbidden
117+
* 422: Unprocessable Entity (validation probably failed, see logs)
118+
99119
***
100120
101121
### Stats

other/speedtest-process.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,17 @@ Speedtest Tracker uses the [Official Ookla CLI](https://www.speedtest.net/apps/c
44

55
{% stepper %}
66
{% step %}
7+
8+
#### Waiting
9+
10+
The speedtest run request was created but has not been started.
11+
{% endstep %}
12+
13+
{% step %}
14+
715
#### Started
816

9-
The Speedtest process is started
17+
The speedtest process has been started by a queue worker.
1018
{% endstep %}
1119

1220
{% step %}

0 commit comments

Comments
 (0)