Appointment doku

This commit is contained in:
daru
2022-05-28 14:38:37 +02:00
parent d9ab365ae4
commit 5b029ee835

View File

@@ -248,7 +248,44 @@ _[]AnimeUser_ (POST/DELETE)
| GET | /api/chat/{id} | Chat für Anime holen | Plaintext chat | {id} = MAL Anime id | | |
| POST | /api/chat/{id}/{user} | Chat für Anime senden | Plaintext chat mit neuer Nachricht | {id} = MAL Anime id; {user} = MAL username | X-HUSO-AUTH | Neue Nachricht in plaintext |
### Appointment [WIP]
### Appointment
| Method | Route | Description | Response | Parameter | Header | POST-Body |
| - | - | - | - | - | - | - |
| GET | /api/appointment | Appointments holen | []Appointment | | | |
| POST | /api/appointment/{user} | Appointment schicken | []Appointment JSON | {user} = MAL username | X-HUSO-AUTH | []Appointment JSON |
| DELETE | /api/appointment/{user} | Von Appointments austragen | []Appointment JSON | {user} = MAL username | X-HUSO-AUTH | []Appointment JSON |
**Verwendung des JSON von GET und POST/DELETE unterscheiden sich. Bei POST/DELETE muss nur das Datum und der zu verändernde Anime angegeben werden und sonst nichts.**
_[]Appointment_ (GET)
```json
[
{
"anime": 40356,
"date": "2022-05-30T20:51:51Z",
"users": [
"TESTUSERNAME",
"TESTUSERNAME2"
]
},
{
"anime": 50265,
"date": "2022-05-31T20:51:51Z",
"users": [
"TESTUSERNAME"
]
}
]
```
_[]Appointment_ (POST/DELETE)
```json
[
{
"anime": 50265,
"date": "2022-05-31T22:51:51Z",
"users": []
}
]
```