Skip to content

Commit fa251cf

Browse files
svenvg93gitbook-bot
authored andcommitted
GitBook: No commit message
1 parent a601016 commit fa251cf

File tree

5 files changed

+28
-238
lines changed

5 files changed

+28
-238
lines changed

SUMMARY.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,18 @@
5252

5353
## 🖥️ API
5454

55-
* [v1](api/v1.md)
56-
* [Latest Result (deprecated)](api/latest-result.md)
55+
* [Authorization](api/authorization.md)
56+
* [Responses](api/responses/README.md)
57+
* ```yaml
58+
type: builtin:openapi
59+
props:
60+
models: true
61+
dependencies:
62+
spec:
63+
ref:
64+
kind: openapi
65+
spec: speedtest-tracker-api
66+
```
5767
5868
## 🤹 Contributing
5969

api/authorization.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Authorization
2+
3+
A "Bearer Token" is required to authenticate into the API, you can generate tokens for your user account on `/admin/api-tokens`. 
4+
5+
### Token Abilities
6+
7+
Each token is provisioned with one or more abilities. When calling an endpoint, the token must include the ability required by that endpoint
8+
9+
| Abilities | Description |
10+
| ------------- | ------------------------------- |
11+
| Read Results | Allows token to read results. |
12+
| Run Speedtest | Allows token to run speedtests. |
13+
| List servers | Allows token to list servers. |
14+

api/latest-result.md

Lines changed: 0 additions & 53 deletions
This file was deleted.

api/responses/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Responses
2+

api/v1.md

Lines changed: 0 additions & 183 deletions
This file was deleted.

0 commit comments

Comments
 (0)