Laurenz/Laterna
1
0
Fork 0
mirror of https://github.com/kaaninchen/Laterna.git synced 2026-09-17 19:12:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: documentation oversights

Browse Source
This commit is contained in:
Siesta
2025-07-20 18:24:10 +02:00
parent c7edddca93
commit 25bd0cc0c8
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -3
View File
@@ -1,6 +1,6 @@
# Laterna # Laterna
## API Documentation ## 🛜 API Documentation
### Base URL ### Base URL
`http://your-server.com/api/v1` `http://your-server.com/api/v1`
@@ -21,8 +21,8 @@ Authorization: <token>
#### Controller #### Controller
| Method | Route | Description | Request Body | | Method | Route | Description | Request Body |
|---------|----------------------------|----------------------------------------|----------------------------------| |---------|----------------------------|----------------------------------------|----------------------------------|
| GET | `/colors/{id}` | Get the current color of an controller | — | | POST | `/controllers` | Create a new controller | — |
| PUT | `/colors/{id}` | Set the color of an controller |`{ "ID": "1" }` | | DELETE | `/controllers` | Delete an existing controller |`{ "ID": 1 }` |
--- ---
@@ -42,6 +42,7 @@ Authorization: <token>
$ curl -X POST http://your-server.com/api/v1/controllers \ $ curl -X POST http://your-server.com/api/v1/controllers \
-H "Authorization: $TOKEN" -H "Authorization: $TOKEN"
``` ```
Respons with the newly assigned ID
#### Delete an controller #### Delete an controller
```bash ```bash