update reports

2025-06-10 00:03:38 +02:00
parent 8262fd90aa
commit 5c41857530
11 changed files with 253 additions and 50 deletions
--- a/README.md
+++ b/README.md
@ -41,6 +41,79 @@

 </details>

+<details>
+<summary><code>POST</code> <code>/api/report</code> (Erstellt einen Report)</summary>
+
+##### Request Body
+
+```
+{
+  // UUID des Report Erstellers
+  "reporter": string,
+  // UUID des Reporteten Spielers
+  "reported": string | null,
+  // Report Grund
+  "reason": string
+}
+```
+
+##### Response Codes
+
+| http code | beschreibung                                                      |
+| --------- | ----------------------------------------------------------------- |
+| 200       | /                                                                 |
+| 400       | Der Request Body ist falsch                                       |
+| 401       | Es wurde ein falsches API Secret angegeben                        |
+| 404       | Der Report Ersteller, oder der reportete Spieler, existiert nicht |
+
+##### Response Body
+
+```
+{
+  // URL, wo der Ersteller den Report abschicken kann
+  "url": string
+}
+```
+
+</details>
+
+<details>
+<summary><code>PUT</code> <code>/api/report</code> (Erstellt einen Abgeschlossenen Report)</summary>
+
+##### Request Body
+
+```
+{
+  // UUID des Reporters. Wenn `null`, wird der Reporter als System interpretiert
+  "reporter": string | null,
+  // UUID des Reporteten Spielers
+  "reported": string,
+  // Report Grund
+  "reason": string,
+  // Inhalt des Reports
+  "body": string | null,
+  // Interne Notiz
+  "notice": string | null,
+  // Öffentliches Statement
+  "statement": string | null,
+  // ID des Strikegrundes
+  "strike_reason_id": number
+}
+```
+
+| http code | beschreibung                                                      |
+| --------- | ----------------------------------------------------------------- |
+| 200       | /                                                                 |
+| 400       | Der Request Body ist falsch                                       |
+| 401       | Es wurde ein falsches API Secret angegeben                        |
+| 404       | Der Report Ersteller, oder der reportete Spieler, existiert nicht |
+
+##### Response Body
+
+`/`
+
+</details>
+
 <details>
 <summary><code>POST</code> <code>/api/player/death</code> (Registriert einen Spielertod)</summary>