From d206db8597d58c732cfc62dc738a62bfaf88b796 Mon Sep 17 00:00:00 2001 From: Jiri Kalvoda Date: Fri, 16 Sep 2022 23:14:39 +0200 Subject: [PATCH] =?UTF-8?q?Strategick=C3=A1:=20Dospecifikov=C3=A1n=C3=AD?= =?UTF-8?q?=20API?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- obsazovani.md | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/obsazovani.md b/obsazovani.md index eb10529..182d127 100644 --- a/obsazovani.md +++ b/obsazovani.md @@ -4,6 +4,16 @@ Obsazování území API --- +Odpověď na libovolný dotaz muže být HTTP error ve tvaru: +``` +{ + status: "error" + description: # Popis chybové události (toto chceme vytisknout!) + http-code: + http-name: # Jméno chybového kódu +} +``` + Parametry: - token: Identifikuje uživatele, zjistí z hlavní stránky webu - game: S jakou hrou (popř. týmem ve hře) se chtějí bavit @@ -77,7 +87,7 @@ nebo ] } # Tah jako celek se provede, chyba jen u některých osob -nebo +nebo { status: "error" @@ -87,11 +97,31 @@ nebo nebo { - status: "too_late" + status: "too-late" +} +``` + +Požadavek na krok: +POST na `/api/step?game=&token=` + +Odpověď: +``` +{ + status: "ok", +} + +nebo + +{ + status: "error" + description: "Je zak\u00e1z\u00e1no krokovat tuto hru" + http-code: 403 + http-name: "Forbidden" } ``` + Interní reprezentace ====================