Browse Source

Strategická: Dospecifikování API

master
Jiří Kalvoda 2 years ago
parent
commit
d206db8597
  1. 32
      obsazovani.md

32
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: <str> # Popis chybové události (toto chceme vytisknout!)
http-code: <int>
http-name: <str> # 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
@ -87,10 +97,30 @@ nebo
nebo
{
status: "too_late"
status: "too-late"
}
```
Požadavek na krok:
POST na `/api/step?game=<jmeno_hry>&token=<token>`
Odpověď:
```
{
status: "ok",
}
nebo
{
status: "error"
description: "Je zak\u00e1z\u00e1no krokovat tuto hru"
http-code: 403
http-name: "Forbidden"
}
```
Interní reprezentace
====================

Loading…
Cancel
Save